You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@freemarker.apache.org by dd...@apache.org on 2017/03/01 18:39:07 UTC

[3/5] incubator-freemarker git commit: Updated/added package.html-s.

Updated/added package.html-s.


Project: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/commit/64ca9c24
Tree: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/tree/64ca9c24
Diff: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/diff/64ca9c24

Branch: refs/heads/3
Commit: 64ca9c24fc42c5ff2cef897ec7d9c94a77adb2d4
Parents: de1bcf77
Author: ddekany <dd...@apache.org>
Authored: Wed Mar 1 19:00:35 2017 +0100
Committer: ddekany <dd...@apache.org>
Committed: Wed Mar 1 19:00:35 2017 +0100

----------------------------------------------------------------------
 .../core/arithmetic/impl/package.html           | 26 ++++++++++++++++++++
 .../freemarker/core/arithmetic/package.html     | 25 +++++++++++++++++++
 .../freemarker/core/model/impl/package.html     | 17 ++-----------
 .../apache/freemarker/core/model/package.html   |  2 +-
 .../core/outputformat/impl/package.html         | 26 ++++++++++++++++++++
 .../freemarker/core/outputformat/package.html   | 25 +++++++++++++++++++
 .../org/apache/freemarker/core/package.html     |  2 +-
 .../core/templateresolver/impl/package.html     | 26 ++++++++++++++++++++
 .../core/templateresolver/package.html          |  2 +-
 .../core/valueformat/impl/package.html          | 26 ++++++++++++++++++++
 .../freemarker/core/valueformat/package.html    | 25 +++++++++++++++++++
 .../java/org/apache/freemarker/dom/package.html |  3 +--
 .../apache/freemarker/servlet/jsp/package.html  |  5 +---
 .../org/apache/freemarker/servlet/package.html  |  3 ++-
 14 files changed, 188 insertions(+), 25 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/64ca9c24/src/main/java/org/apache/freemarker/core/arithmetic/impl/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/freemarker/core/arithmetic/impl/package.html b/src/main/java/org/apache/freemarker/core/arithmetic/impl/package.html
new file mode 100644
index 0000000..e093fd6
--- /dev/null
+++ b/src/main/java/org/apache/freemarker/core/arithmetic/impl/package.html
@@ -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.
+  -->
+<html>
+<head>
+</head>
+<body>
+<p>Arithmetic used in templates: Standard implementations. This package is part of the
+published API, that is, user code can safely depend on it.</p>
+</body>
+</html>

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/64ca9c24/src/main/java/org/apache/freemarker/core/arithmetic/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/freemarker/core/arithmetic/package.html b/src/main/java/org/apache/freemarker/core/arithmetic/package.html
new file mode 100644
index 0000000..18d2c7f
--- /dev/null
+++ b/src/main/java/org/apache/freemarker/core/arithmetic/package.html
@@ -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.
+  -->
+<html>
+<head>
+</head>
+<body>
+<p>Arithmetic used in templates: Base classes/interfaces.</p>
+</body>
+</html>

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/64ca9c24/src/main/java/org/apache/freemarker/core/model/impl/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/freemarker/core/model/impl/package.html b/src/main/java/org/apache/freemarker/core/model/impl/package.html
index 9c315a4..b3db746 100644
--- a/src/main/java/org/apache/freemarker/core/model/impl/package.html
+++ b/src/main/java/org/apache/freemarker/core/model/impl/package.html
@@ -18,22 +18,9 @@
 -->
 <html>
 <head>
-<title></title>
 </head>
 <body>
-
-<p>The {@linkplain org.apache.freemarker.core.model.impl.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.DefaultObjectWrapper#wrap(Object)}and {@link
-freemarker.ext.beans.DefaultObjectWrapper#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>
-
+<p>Data model and template language type system: Standard implementations. This package is part of the
+published API, that is, user code can safely depend on it.</p>
 </body>
 </html>

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/64ca9c24/src/main/java/org/apache/freemarker/core/model/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/freemarker/core/model/package.html b/src/main/java/org/apache/freemarker/core/model/package.html
index 891509e..a2a9cfe 100644
--- a/src/main/java/org/apache/freemarker/core/model/package.html
+++ b/src/main/java/org/apache/freemarker/core/model/package.html
@@ -20,6 +20,6 @@
 <head>
 </head>
 <body>
-<p>Things related to <tt>TemplateModel</tt>-s (basically the type system of FTL).</p> 
+<p>Data model and template language type system: Base classes/interfaces.</p>
 </body>
 </html>

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/64ca9c24/src/main/java/org/apache/freemarker/core/outputformat/impl/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/freemarker/core/outputformat/impl/package.html b/src/main/java/org/apache/freemarker/core/outputformat/impl/package.html
new file mode 100644
index 0000000..2ff5d6d
--- /dev/null
+++ b/src/main/java/org/apache/freemarker/core/outputformat/impl/package.html
@@ -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.
+  -->
+<html>
+<head>
+</head>
+<body>
+<p>Template output format: Standard implementations. This package is part of the
+published API, that is, user code can safely depend on it.</p>
+</body>
+</html>

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/64ca9c24/src/main/java/org/apache/freemarker/core/outputformat/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/freemarker/core/outputformat/package.html b/src/main/java/org/apache/freemarker/core/outputformat/package.html
new file mode 100644
index 0000000..47bebfe
--- /dev/null
+++ b/src/main/java/org/apache/freemarker/core/outputformat/package.html
@@ -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.
+  -->
+<html>
+<head>
+</head>
+<body>
+<p>Template output format: Base classes/interfaces</p>
+</body>
+</html>

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/64ca9c24/src/main/java/org/apache/freemarker/core/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/freemarker/core/package.html b/src/main/java/org/apache/freemarker/core/package.html
index 3f622ec..be9dab9 100644
--- a/src/main/java/org/apache/freemarker/core/package.html
+++ b/src/main/java/org/apache/freemarker/core/package.html
@@ -20,7 +20,7 @@
 <head>
 </head>
 <body>
-<p><b>The fundamental, most commonly used API-s of FreeMarker;</b>
+<p><b>The most commonly used API-s of FreeMarker;</b>
 start with {@link freemarker.template.Configuration Configuration} (see also the
 <a href="http://freemarker.org/docs/pgui_quickstart.html" target="_blank">Getting Stared</a> in the Manual.)</p>
 </body>

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/64ca9c24/src/main/java/org/apache/freemarker/core/templateresolver/impl/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/freemarker/core/templateresolver/impl/package.html b/src/main/java/org/apache/freemarker/core/templateresolver/impl/package.html
new file mode 100644
index 0000000..8734174
--- /dev/null
+++ b/src/main/java/org/apache/freemarker/core/templateresolver/impl/package.html
@@ -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.
+  -->
+<html>
+<head>
+</head>
+<body>
+<p>Template lookup, loading and caching: Standard implementations. This package is part of the
+published API, that is, user code can safely depend on it.</p>
+</body>
+</html>

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/64ca9c24/src/main/java/org/apache/freemarker/core/templateresolver/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/freemarker/core/templateresolver/package.html b/src/main/java/org/apache/freemarker/core/templateresolver/package.html
index 9f43949..dd01586 100644
--- a/src/main/java/org/apache/freemarker/core/templateresolver/package.html
+++ b/src/main/java/org/apache/freemarker/core/templateresolver/package.html
@@ -20,6 +20,6 @@
 <head>
 </head>
 <body>
-<p>Template lookup, loading, caching and template naming rules.</p>
+<p>Template lookup, loading, and caching: Base classes/interfaces</p>
 </body>
 </html>

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/64ca9c24/src/main/java/org/apache/freemarker/core/valueformat/impl/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/freemarker/core/valueformat/impl/package.html b/src/main/java/org/apache/freemarker/core/valueformat/impl/package.html
new file mode 100644
index 0000000..b776668
--- /dev/null
+++ b/src/main/java/org/apache/freemarker/core/valueformat/impl/package.html
@@ -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.
+  -->
+<html>
+<head>
+</head>
+<body>
+<p>Formatting values shown in templates: Standard implementations. This package is part of the published API, that
+is, user code can safely depend on it.</p>
+</body>
+</html>

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/64ca9c24/src/main/java/org/apache/freemarker/core/valueformat/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/freemarker/core/valueformat/package.html b/src/main/java/org/apache/freemarker/core/valueformat/package.html
new file mode 100644
index 0000000..bfb8183
--- /dev/null
+++ b/src/main/java/org/apache/freemarker/core/valueformat/package.html
@@ -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.
+  -->
+<html>
+<head>
+</head>
+<body>
+<p>Formatting values shown in templates: Base classes/interfaces</p>
+</body>
+</html>

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/64ca9c24/src/main/java/org/apache/freemarker/dom/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/freemarker/dom/package.html b/src/main/java/org/apache/freemarker/dom/package.html
index d9239e4..61b1737 100644
--- a/src/main/java/org/apache/freemarker/dom/package.html
+++ b/src/main/java/org/apache/freemarker/dom/package.html
@@ -24,8 +24,7 @@
 
 <p>Exposes DOM XML nodes to templates as easily traversable trees;
 see <a href="http://freemarker.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.
+The default object wrapper of FreeMarker can automatically wraps W3C nodes with this.
 
 </body>
 </html>

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/64ca9c24/src/main/java/org/apache/freemarker/servlet/jsp/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/freemarker/servlet/jsp/package.html b/src/main/java/org/apache/freemarker/servlet/jsp/package.html
index 6a97480..8d65a1c 100644
--- a/src/main/java/org/apache/freemarker/servlet/jsp/package.html
+++ b/src/main/java/org/apache/freemarker/servlet/jsp/package.html
@@ -21,9 +21,6 @@
 </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.
+Allows JSP custom tags to be used inside FreeMarker templates as if they where FreeMarker directives.
 </body>
 </html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/64ca9c24/src/main/java/org/apache/freemarker/servlet/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/freemarker/servlet/package.html b/src/main/java/org/apache/freemarker/servlet/package.html
index 99f7e24..c364bb0 100644
--- a/src/main/java/org/apache/freemarker/servlet/package.html
+++ b/src/main/java/org/apache/freemarker/servlet/package.html
@@ -20,6 +20,7 @@
 <body>
 <p>Servlet for legacy "Model 2" frameworks that allows using FreeMarker
 templates instead of JSP as the MVC View
-(see <a href="http://freemarker.org/docs/pgui_misc_servlet.html" target="_blank">in the Manual</a>).</p>
+(see <a href="http://freemarker.org/docs/pgui_misc_servlet.html" target="_blank">in the Manual</a>), also
+custom JSP tag support.</p>
 </body>
 </html>