Skip to content

Commit

Permalink
Converted package.html-s to package-info.java-s, as otherwise they we…
Browse files Browse the repository at this point in the history
…re missing from the javadoc output in the new build.
  • Loading branch information
ddekany committed Jun 4, 2024
1 parent b448ea6 commit ef7b05d
Show file tree
Hide file tree
Showing 38 changed files with 491 additions and 561 deletions.
26 changes: 26 additions & 0 deletions freemarker-core/src/main/java/freemarker/cache/package-info.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

/**
* Template <em>loading</em> and caching.
* Beside the actual template cache, it contains loaders that can load template files from the file system, from the
* classpath, or from a web application context. If you have specific needs, you can plug custom template loaders into
* the system by implementing the template loader interface.
*/
package freemarker.cache;
30 changes: 0 additions & 30 deletions freemarker-core/src/main/java/freemarker/cache/package.html

This file was deleted.

24 changes: 24 additions & 0 deletions freemarker-core/src/main/java/freemarker/core/package-info.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

/**
* The seldom used or advanced parts of the fundamental FreeMarker API, compared to {@link freemarker.template}.
* This package also encloses FreeMarker's core parsing/rendering functionality.
*/
package freemarker.core;
26 changes: 0 additions & 26 deletions freemarker-core/src/main/java/freemarker/core/package.html

This file was deleted.

24 changes: 24 additions & 0 deletions freemarker-core/src/main/java/freemarker/debug/package-info.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

/**
* Debugging API; experimental status, might change!
* This is to support debugging in IDE-s. If you are working on a client for this, don't hesitate to contact us!
*/
package freemarker.debug;
27 changes: 0 additions & 27 deletions freemarker-core/src/main/java/freemarker/debug/package.html

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

/**
* The {@linkplain freemarker.template.DefaultObjectWrapper default object wrapper} of FreeMarker uses
* this to expose Java Beans and POJO-s to templates.
*
* <p>Most of the issues dealing with beans are handled by the {@link freemarker.ext.beans.BeansWrapper#wrap(Object)}
* and {@link freemarker.ext.beans.BeansWrapper#getStaticModels()} methods. In normal cases, these are the only methods
* you should use to turn an arbitrary Java object into a FreeMarker {@link freemarker.template.TemplateModel}.
* Additionally, you can manually create instance of any wrapper class using its constructors. Note, however that in
* such cases you bypass the eventual model caching of the wrapper.</p>
*/
package freemarker.ext.beans;
39 changes: 0 additions & 39 deletions freemarker-core/src/main/java/freemarker/ext/beans/package.html

This file was deleted.

26 changes: 26 additions & 0 deletions freemarker-core/src/main/java/freemarker/ext/dom/package-info.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

/**
* Exposes DOM XML nodes to templates as easily traversable trees;
* see <a href="https://freemarker.apache.org/docs/xgui.html" target="_blank">in the Manual</a>. The
* {@link freemarker.template.DefaultObjectWrapper default object wrapper} of FreeMarker automatically wraps W3C nodes
* with this.
*/
package freemarker.ext.dom;
31 changes: 0 additions & 31 deletions freemarker-core/src/main/java/freemarker/ext/dom/package.html

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

/**
* Deprecated, use W3C DOM ({@link freemarker.ext.dom}) instead;
* Exposes <a href="http://www.jdom.org/" target="_blank">JDOM</a> XML nodes to templates.
*/
package freemarker.ext.jdom;
29 changes: 0 additions & 29 deletions freemarker-core/src/main/java/freemarker/ext/jdom/package.html

This file was deleted.

23 changes: 23 additions & 0 deletions freemarker-core/src/main/java/freemarker/ext/package-info.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

/**
* Extensions to FreeMarker's core functionality.
*/
package freemarker.ext;
Loading

0 comments on commit ef7b05d

Please sign in to comment.