This is an automated email from the ASF dual-hosted git repository. ddekany pushed a commit to branch 2.3.33-maintenance in repository https://gitbox.apache.org/repos/asf/freemarker.git
commit ef7b05d6aaeac4c6d636a618fdb20bd772f14b86 Author: ddekany <[email protected]> AuthorDate: Tue Jun 4 18:58:37 2024 +0200 Converted package.html-s to package-info.java-s, as otherwise they were missing from the javadoc output in the new build. --- .../main/java/freemarker/cache/package-info.java | 26 ++++++++++++++ .../src/main/java/freemarker/cache/package.html | 30 ---------------- .../main/java/freemarker/core/package-info.java | 24 +++++++++++++ .../src/main/java/freemarker/core/package.html | 26 -------------- .../main/java/freemarker/debug/package-info.java | 24 +++++++++++++ .../src/main/java/freemarker/debug/package.html | 27 -------------- .../java/freemarker/ext/beans/package-info.java | 30 ++++++++++++++++ .../main/java/freemarker/ext/beans/package.html | 39 -------------------- .../main/java/freemarker/ext/dom/package-info.java | 26 ++++++++++++++ .../src/main/java/freemarker/ext/dom/package.html | 31 ---------------- .../java/freemarker/ext/jdom/package-info.java | 24 +++++++++++++ .../src/main/java/freemarker/ext/jdom/package.html | 29 --------------- .../src/main/java/freemarker/ext/package-info.java | 23 ++++++++++++ .../src/main/java/freemarker/ext/package.html | 25 ------------- .../java/freemarker/ext/rhino/package-info.java | 23 ++++++++++++ .../main/java/freemarker/ext/rhino/package.html | 28 --------------- .../java/freemarker/ext/util/package-info.java | 23 ++++++++++++ .../src/main/java/freemarker/ext/util/package.html | 23 ------------ .../main/java/freemarker/ext/xml/package-info.java | 24 +++++++++++++ .../src/main/java/freemarker/ext/xml/package.html | 28 --------------- .../src/main/java/freemarker/log/package-info.java | 23 ++++++++++++ .../src/main/java/freemarker/log/package.html | 27 -------------- .../java/freemarker/template/package-info.java | 26 ++++++++++++++ .../src/main/java/freemarker/template/package.html | 27 -------------- .../freemarker/template/utility/package-info.java | 23 ++++++++++++ .../java/freemarker/template/utility/package.html | 25 ------------- .../main/java/freemarker/ext/jsp/package-info.java | 28 +++++++++++++++ .../src/main/java/freemarker/ext/jsp/package.html | 33 ----------------- .../java/freemarker/ext/servlet/package-info.java | 28 +++++++++++++++ .../main/java/freemarker/ext/servlet/package.html | 29 --------------- .../main/java/freemarker/ext/ant/package-info.java | 24 +++++++++++++ .../src/main/java/freemarker/ext/ant/package.html | 27 -------------- .../java/freemarker/ext/jython/package-info.java | 30 ++++++++++++++++ .../main/java/freemarker/ext/jython/package.html | 37 ------------------- .../test/templatesuite/package-info.java | 37 +++++++++++++++++++ .../freemarker/test/templatesuite/package.html | 42 ---------------------- .../main/java/freemarker/test/package-info.java | 25 +++++++++++++ .../src/main/java/freemarker/test/package.html | 28 --------------- 38 files changed, 491 insertions(+), 561 deletions(-) diff --git a/freemarker-core/src/main/java/freemarker/cache/package-info.java b/freemarker-core/src/main/java/freemarker/cache/package-info.java new file mode 100644 index 00000000..e2b23337 --- /dev/null +++ b/freemarker-core/src/main/java/freemarker/cache/package-info.java @@ -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; \ No newline at end of file diff --git a/freemarker-core/src/main/java/freemarker/cache/package.html b/freemarker-core/src/main/java/freemarker/cache/package.html deleted file mode 100644 index 24662059..00000000 --- a/freemarker-core/src/main/java/freemarker/cache/package.html +++ /dev/null @@ -1,30 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -</head> -<body bgcolor="white"> -<p>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. -</p> -</body> -</html> diff --git a/freemarker-core/src/main/java/freemarker/core/package-info.java b/freemarker-core/src/main/java/freemarker/core/package-info.java new file mode 100644 index 00000000..5e8a0a14 --- /dev/null +++ b/freemarker-core/src/main/java/freemarker/core/package-info.java @@ -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; \ No newline at end of file diff --git a/freemarker-core/src/main/java/freemarker/core/package.html b/freemarker-core/src/main/java/freemarker/core/package.html deleted file mode 100644 index a7e85b81..00000000 --- a/freemarker-core/src/main/java/freemarker/core/package.html +++ /dev/null @@ -1,26 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -</head> -<body bgcolor="white"> -<p>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.</p> -</body> -</html> diff --git a/freemarker-core/src/main/java/freemarker/debug/package-info.java b/freemarker-core/src/main/java/freemarker/debug/package-info.java new file mode 100644 index 00000000..b4ccfe7e --- /dev/null +++ b/freemarker-core/src/main/java/freemarker/debug/package-info.java @@ -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; \ No newline at end of file diff --git a/freemarker-core/src/main/java/freemarker/debug/package.html b/freemarker-core/src/main/java/freemarker/debug/package.html deleted file mode 100644 index 677b8422..00000000 --- a/freemarker-core/src/main/java/freemarker/debug/package.html +++ /dev/null @@ -1,27 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -</head> -<body bgcolor="white"> -<p>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!</p> -</body> -</html> diff --git a/freemarker-core/src/main/java/freemarker/ext/beans/package-info.java b/freemarker-core/src/main/java/freemarker/ext/beans/package-info.java new file mode 100644 index 00000000..046e1280 --- /dev/null +++ b/freemarker-core/src/main/java/freemarker/ext/beans/package-info.java @@ -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; \ No newline at end of file diff --git a/freemarker-core/src/main/java/freemarker/ext/beans/package.html b/freemarker-core/src/main/java/freemarker/ext/beans/package.html deleted file mode 100644 index 8c9fce0b..00000000 --- a/freemarker-core/src/main/java/freemarker/ext/beans/package.html +++ /dev/null @@ -1,39 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -<title></title> -</head> -<body> - -<p>The {@linkplain freemarker.template.DefaultObjectWrapper default object wrapper} of FreeMarker uses -this to expose Java Beans and POJO-s to templates.</p> - -<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> - -</body> -</html> diff --git a/freemarker-core/src/main/java/freemarker/ext/dom/package-info.java b/freemarker-core/src/main/java/freemarker/ext/dom/package-info.java new file mode 100644 index 00000000..07d65692 --- /dev/null +++ b/freemarker-core/src/main/java/freemarker/ext/dom/package-info.java @@ -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; \ No newline at end of file diff --git a/freemarker-core/src/main/java/freemarker/ext/dom/package.html b/freemarker-core/src/main/java/freemarker/ext/dom/package.html deleted file mode 100644 index 3260f706..00000000 --- a/freemarker-core/src/main/java/freemarker/ext/dom/package.html +++ /dev/null @@ -1,31 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -<title></title> -</head> -<body> - -<p>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. - -</body> -</html> diff --git a/freemarker-core/src/main/java/freemarker/ext/jdom/package-info.java b/freemarker-core/src/main/java/freemarker/ext/jdom/package-info.java new file mode 100644 index 00000000..ca6268f5 --- /dev/null +++ b/freemarker-core/src/main/java/freemarker/ext/jdom/package-info.java @@ -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; \ No newline at end of file diff --git a/freemarker-core/src/main/java/freemarker/ext/jdom/package.html b/freemarker-core/src/main/java/freemarker/ext/jdom/package.html deleted file mode 100644 index 8752b9ac..00000000 --- a/freemarker-core/src/main/java/freemarker/ext/jdom/package.html +++ /dev/null @@ -1,29 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -<title></title> -</head> -<body> - -<p>Deprecated, use W3C DOM ({@link freemarker.ext.dom}) instead; -Exposes <a href="http://www.jdom.org/"; target="_blank">JDOM</a> XML nodes to templates. - -</body> -</html> diff --git a/freemarker-core/src/main/java/freemarker/ext/package-info.java b/freemarker-core/src/main/java/freemarker/ext/package-info.java new file mode 100644 index 00000000..31cb1378 --- /dev/null +++ b/freemarker-core/src/main/java/freemarker/ext/package-info.java @@ -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; \ No newline at end of file diff --git a/freemarker-core/src/main/java/freemarker/ext/package.html b/freemarker-core/src/main/java/freemarker/ext/package.html deleted file mode 100644 index 5070a102..00000000 --- a/freemarker-core/src/main/java/freemarker/ext/package.html +++ /dev/null @@ -1,25 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -</head> -<body bgcolor="white"> -<p>Extensions to FreeMarker's core functionality.</p> -</body> -</html> \ No newline at end of file diff --git a/freemarker-core/src/main/java/freemarker/ext/rhino/package-info.java b/freemarker-core/src/main/java/freemarker/ext/rhino/package-info.java new file mode 100644 index 00000000..dd886b22 --- /dev/null +++ b/freemarker-core/src/main/java/freemarker/ext/rhino/package-info.java @@ -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. + */ + +/** + * Exposes Rhino (ECMAScript) objects to templates. + */ +package freemarker.ext.rhino; \ No newline at end of file diff --git a/freemarker-core/src/main/java/freemarker/ext/rhino/package.html b/freemarker-core/src/main/java/freemarker/ext/rhino/package.html deleted file mode 100644 index ba93c680..00000000 --- a/freemarker-core/src/main/java/freemarker/ext/rhino/package.html +++ /dev/null @@ -1,28 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -<title></title> -</head> -<body> - -<p>Exposes Rhino (ECMAScript) objects to templates. - -</body> -</html> diff --git a/freemarker-core/src/main/java/freemarker/ext/util/package-info.java b/freemarker-core/src/main/java/freemarker/ext/util/package-info.java new file mode 100644 index 00000000..373f9eb3 --- /dev/null +++ b/freemarker-core/src/main/java/freemarker/ext/util/package-info.java @@ -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. + */ + +/** + * Various classes used by {@code freemarker.ext} but might be useful outside it too. + */ +package freemarker.ext.util; \ No newline at end of file diff --git a/freemarker-core/src/main/java/freemarker/ext/util/package.html b/freemarker-core/src/main/java/freemarker/ext/util/package.html deleted file mode 100644 index aa4c1b39..00000000 --- a/freemarker-core/src/main/java/freemarker/ext/util/package.html +++ /dev/null @@ -1,23 +0,0 @@ -<!-- - 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. ---> -<html> -<body> -<p>Various classes used by {@code freemarker.ext} but might be useful outside it too.</p> -</body> -</html> diff --git a/freemarker-core/src/main/java/freemarker/ext/xml/package-info.java b/freemarker-core/src/main/java/freemarker/ext/xml/package-info.java new file mode 100644 index 00000000..3c18634e --- /dev/null +++ b/freemarker-core/src/main/java/freemarker/ext/xml/package-info.java @@ -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 with {@link freemarker.ext.dom} instead; + * Exposes XML from DOM, dom4j or JDOM nodes, uniformly. + */ +package freemarker.ext.xml; \ No newline at end of file diff --git a/freemarker-core/src/main/java/freemarker/ext/xml/package.html b/freemarker-core/src/main/java/freemarker/ext/xml/package.html deleted file mode 100644 index 271dff7f..00000000 --- a/freemarker-core/src/main/java/freemarker/ext/xml/package.html +++ /dev/null @@ -1,28 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -<title></title> -</head> -<body> - -<p>Deprecated, use W3C DOM with {@link freemarker.ext.dom} instead; -Exposes XML from DOM, dom4j or JDOM nodes, uniformly.</p> -</body> -</html> diff --git a/freemarker-core/src/main/java/freemarker/log/package-info.java b/freemarker-core/src/main/java/freemarker/log/package-info.java new file mode 100644 index 00000000..66c19ea4 --- /dev/null +++ b/freemarker-core/src/main/java/freemarker/log/package-info.java @@ -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. + */ + +/** + * Logging facility; dispatches FreeMarker log messages to the chosen logger library. + */ +package freemarker.log; \ No newline at end of file diff --git a/freemarker-core/src/main/java/freemarker/log/package.html b/freemarker-core/src/main/java/freemarker/log/package.html deleted file mode 100644 index ada58aa4..00000000 --- a/freemarker-core/src/main/java/freemarker/log/package.html +++ /dev/null @@ -1,27 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -</head> -<BODY> -<p> -Logging facility; dispatches FreeMarker log messages to the chosen logger library. - -</body> -</html> \ No newline at end of file diff --git a/freemarker-core/src/main/java/freemarker/template/package-info.java b/freemarker-core/src/main/java/freemarker/template/package-info.java new file mode 100644 index 00000000..46b33fcb --- /dev/null +++ b/freemarker-core/src/main/java/freemarker/template/package-info.java @@ -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. + */ + +/** + * <b>The fundamental, most commonly used API-s of FreeMarker;</b> + * start with {@link freemarker.template.Configuration Configuration} (see also the + * <a href="https://freemarker.apache.org/docs/pgui_quickstart.html"; target="_blank">Getting Started</a> in the + * Manual.) + */ +package freemarker.template; \ No newline at end of file diff --git a/freemarker-core/src/main/java/freemarker/template/package.html b/freemarker-core/src/main/java/freemarker/template/package.html deleted file mode 100644 index 72bf0354..00000000 --- a/freemarker-core/src/main/java/freemarker/template/package.html +++ /dev/null @@ -1,27 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -</head> -<body> -<p><b>The fundamental, most commonly used API-s of FreeMarker;</b> -start with {@link freemarker.template.Configuration Configuration} (see also the -<a href="https://freemarker.apache.org/docs/pgui_quickstart.html"; target="_blank">Getting Started</a> in the Manual.)</p> -</body> -</html> diff --git a/freemarker-core/src/main/java/freemarker/template/utility/package-info.java b/freemarker-core/src/main/java/freemarker/template/utility/package-info.java new file mode 100644 index 00000000..34a4ebce --- /dev/null +++ b/freemarker-core/src/main/java/freemarker/template/utility/package-info.java @@ -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. + */ + +/** + * Various classes used by core FreeMarker code but might be useful outside of it too. + */ +package freemarker.template.utility; \ No newline at end of file diff --git a/freemarker-core/src/main/java/freemarker/template/utility/package.html b/freemarker-core/src/main/java/freemarker/template/utility/package.html deleted file mode 100644 index e90df613..00000000 --- a/freemarker-core/src/main/java/freemarker/template/utility/package.html +++ /dev/null @@ -1,25 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -</head> -<body bgcolor="white"> -<p>Various classes used by core FreeMarker code but might be useful outside of it too.</p> -</body> -</html> \ No newline at end of file diff --git a/freemarker-javax-servlet/src/main/java/freemarker/ext/jsp/package-info.java b/freemarker-javax-servlet/src/main/java/freemarker/ext/jsp/package-info.java new file mode 100644 index 00000000..50f44460 --- /dev/null +++ b/freemarker-javax-servlet/src/main/java/freemarker/ext/jsp/package-info.java @@ -0,0 +1,28 @@ +/* + * 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. + */ + +/** + * Classes for two-way FreeMarker-JSP integration. It contains both a JSP custom tag that allows embedding of FreeMarker + * templates inside JSP pages, as well as the infrastructure that allows JSP custom tags to be used inside FreeMarker + * templates. + * + * Note that this is for the legacy "javax" Servlet/JSP API; for Jakarta (that is, in modern Servlet containers), + * use the <code>freemarker.ext.jakarta.jsp</code> package instead (since 2.3.33). + */ +package freemarker.ext.jsp; \ No newline at end of file diff --git a/freemarker-javax-servlet/src/main/java/freemarker/ext/jsp/package.html b/freemarker-javax-servlet/src/main/java/freemarker/ext/jsp/package.html deleted file mode 100644 index f04a3d14..00000000 --- a/freemarker-javax-servlet/src/main/java/freemarker/ext/jsp/package.html +++ /dev/null @@ -1,33 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -</head> -<body> -<p> -Classes for two-way FreeMarker-JSP integration. It contains both a JSP -custom tag that allows embedding of FreeMarker templates inside JSP -pages, as well as the infrastructure that allows JSP custom tags to be -used inside FreeMarker templates. - -<p>Note that this is for the legacy "javax" Servlet/JSP API; for Jakarta (that is, in modern Servlet containers), use -the <code>freemarker.ext.jakarta.jsp</code> package instead (since 2.3.33). - -</body> -</html> \ No newline at end of file diff --git a/freemarker-javax-servlet/src/main/java/freemarker/ext/servlet/package-info.java b/freemarker-javax-servlet/src/main/java/freemarker/ext/servlet/package-info.java new file mode 100644 index 00000000..fe9198c1 --- /dev/null +++ b/freemarker-javax-servlet/src/main/java/freemarker/ext/servlet/package-info.java @@ -0,0 +1,28 @@ +/* + * 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. + */ + +/** + * Servlet for legacy "Model 2" frameworks that allows using FreeMarker + * templates instead of JSP as the MVC View (see <a href="https://freemarker.apache.org/docs/pgui_misc_servlet.html"; + * target="_blank">in the Manual</a>).</p> + * + * <p>Note that this is for the legacy "javax" Servlet/JSP API; for Jakarta (that is, in modern Servlet containers), + * use the {@code freemarker.ext.jakarta.servlet} package instead (since 2.3.33). + */ +package freemarker.ext.servlet; \ No newline at end of file diff --git a/freemarker-javax-servlet/src/main/java/freemarker/ext/servlet/package.html b/freemarker-javax-servlet/src/main/java/freemarker/ext/servlet/package.html deleted file mode 100644 index 9f610666..00000000 --- a/freemarker-javax-servlet/src/main/java/freemarker/ext/servlet/package.html +++ /dev/null @@ -1,29 +0,0 @@ -<!-- - 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. ---> -<html> -<body> -<p>Servlet for legacy "Model 2" frameworks that allows using FreeMarker -templates instead of JSP as the MVC View -(see <a href="https://freemarker.apache.org/docs/pgui_misc_servlet.html"; target="_blank">in the Manual</a>).</p> - -<p>Note that this is for the legacy "javax" Servlet/JSP API; for Jakarta (that is, in modern Servlet containers), use -the <code>freemarker.ext.jakarta.servlet</code> package instead (since 2.3.33). - -</body> -</html> diff --git a/freemarker-jython20/src/main/java/freemarker/ext/ant/package-info.java b/freemarker-jython20/src/main/java/freemarker/ext/ant/package-info.java new file mode 100644 index 00000000..a79be921 --- /dev/null +++ b/freemarker-jython20/src/main/java/freemarker/ext/ant/package-info.java @@ -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. + */ + +/** + * <a href="http://jakarta.apache.org/ant"; target="_blank">Ant task</a> to transform XML files + * with a template; a more powerful alternative is <a href="http://fmpp.sourceforge.net/"; target="_blank">FMPP</a>. + */ +package freemarker.ext.ant; \ No newline at end of file diff --git a/freemarker-jython20/src/main/java/freemarker/ext/ant/package.html b/freemarker-jython20/src/main/java/freemarker/ext/ant/package.html deleted file mode 100644 index c310f65a..00000000 --- a/freemarker-jython20/src/main/java/freemarker/ext/ant/package.html +++ /dev/null @@ -1,27 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -</head> -<BODY> -<p> -<a href="http://jakarta.apache.org/ant"; target="_blank">Ant task</a> to transform XML files -with a template; a more powerful alternative is <a href="http://fmpp.sourceforge.net/"; target="_blank">FMPP</a>. -</body> -</html> \ No newline at end of file diff --git a/freemarker-jython20/src/main/java/freemarker/ext/jython/package-info.java b/freemarker-jython20/src/main/java/freemarker/ext/jython/package-info.java new file mode 100644 index 00000000..2a06cb82 --- /dev/null +++ b/freemarker-jython20/src/main/java/freemarker/ext/jython/package-info.java @@ -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. + */ + +/** + * Exposes <a href="http://www.jython.org"; target="_blank">Jython</a> objects to templates. + * The {@link freemarker.template.DefaultObjectWrapper default object wrapper} of FreeMarker automatically wraps Jython + * nodes with this. + * + * <p>Most of the issues dealing with Jython objects are handled by the + * {@link freemarker.ext.jython.JythonWrapper#wrap(Object)} method. In normal cases, this is the only method you should + * use to turn an arbitrary Jython object into a FreeMarker {@link freemarker.template.TemplateModel}. Additionally, you + * can manually create instances of any wrapper class using its constructors. + */ +package freemarker.ext.jython; \ No newline at end of file diff --git a/freemarker-jython20/src/main/java/freemarker/ext/jython/package.html b/freemarker-jython20/src/main/java/freemarker/ext/jython/package.html deleted file mode 100644 index e6629593..00000000 --- a/freemarker-jython20/src/main/java/freemarker/ext/jython/package.html +++ /dev/null @@ -1,37 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -<title></title> -</head> -<body> - -<p>Exposes <a href="http://www.jython.org"; target="_blank">Jython</a> objects to templates. -The {@link freemarker.template.DefaultObjectWrapper default object wrapper} of FreeMarker -automatically wraps Jython nodes with this. - -<p>Most of the issues dealing with Jython objects are handled by the -{@link freemarker.ext.jython.JythonWrapper#wrap(Object)} method. In -normal cases, this is the only method you should use to turn an -arbitrary Jython object into a FreeMarker -{@link freemarker.template.TemplateModel}. Additionally, you can -manually create instances of any wrapper class using its constructors. - -</body> -</html> diff --git a/freemarker-jython25/src/test/java/freemarker/test/templatesuite/package-info.java b/freemarker-jython25/src/test/java/freemarker/test/templatesuite/package-info.java new file mode 100644 index 00000000..df05c788 --- /dev/null +++ b/freemarker-jython25/src/test/java/freemarker/test/templatesuite/package-info.java @@ -0,0 +1,37 @@ +/* + * 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. + */ + +/** + * JUnit test-suite that processes FreeMarker templates and compare their + * output to reference files. + * + * <p>To add a test-case, go to + * {@code src/test/resources/freemarker/test/templatesuite/} and inside that + * directory:</p> + * + * <ol> + * <li>Add a template to under {@code templates/} with whatever meaningful file name</li> + * <li>Add the expected output to {@code references/} with exactly the same file name</li> + * <li>Add a new {@code testcase} element to {@code testcases.xml}</li> + * <li>If you want to add items to the data-model or do something else special, modify the {@code setUp()} method in + * {@code src/test/java/freemarker/test/templatesuite/TemplateTestCase.java} + * </li> + * </ol> + */ +package freemarker.test.templatesuite; \ No newline at end of file diff --git a/freemarker-jython25/src/test/java/freemarker/test/templatesuite/package.html b/freemarker-jython25/src/test/java/freemarker/test/templatesuite/package.html deleted file mode 100644 index 08f4c9b1..00000000 --- a/freemarker-jython25/src/test/java/freemarker/test/templatesuite/package.html +++ /dev/null @@ -1,42 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -</head> -<body> - -<p>JUnit test-suite that processes FreeMarker templates and compare their -output to reference files.</p> - -<p>To add a test-case, go to -<code>src/test/resources/freemarker/test/templatesuite/</code> and inside that -directory:</p> -<ol> - <li>Add a template to under <code>templates/</code> with whatever meaningful - file name</li> - <li>Add the expected output to <code>references/</code> with exactly the same - file name</li> - <li>Add a new <code>testcase</code> elemen to <code>testcases.xml</code></li> - <li>If you want to add items to the data-model or do something else special, - modify the <code>setUp()</code> method in - <code>src/test/java/freemarker/test/templatesuite/TemplateTestCase.java</code> - </li> -</ol> -</body> -</html> diff --git a/freemarker-test-utils/src/main/java/freemarker/test/package-info.java b/freemarker-test-utils/src/main/java/freemarker/test/package-info.java new file mode 100644 index 00000000..2b62f376 --- /dev/null +++ b/freemarker-test-utils/src/main/java/freemarker/test/package-info.java @@ -0,0 +1,25 @@ +/* + * 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. + */ + +/** + * Testing-related classes that don't fit into the normal packages. + * Normally you put the test classes into the same package where the tested classes are, but under + * {@code src/test/java/} instead of under {@code src/main/java/}.</p> + */ +package freemarker.test; \ No newline at end of file diff --git a/freemarker-test-utils/src/main/java/freemarker/test/package.html b/freemarker-test-utils/src/main/java/freemarker/test/package.html deleted file mode 100644 index 14632bc0..00000000 --- a/freemarker-test-utils/src/main/java/freemarker/test/package.html +++ /dev/null @@ -1,28 +0,0 @@ -<!-- - 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. ---> -<html> -<head> -</head> -<body> -<p>Testing-related classes that don't fit into the normal packages. -Normally you put the test classes into the same package where the -tested classes are, but under <code>src/test/java/<code> instead of -under <code>src/main/java/<code>.</p> -</body> -</html>
