freemarker-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ddek...@apache.org
Subject [12/15] incubator-freemarker git commit: (Adjusted some JavaDoc comments)
Date Sun, 13 Dec 2015 16:02:29 GMT
(Adjusted some JavaDoc comments)


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

Branch: refs/heads/2.3-gae
Commit: 2e3919625289aa90561eb6d7a33fd61e9532ec56
Parents: 3d7e662
Author: ddekany <ddekany@apache.org>
Authored: Sun Dec 13 15:15:45 2015 +0100
Committer: ddekany <ddekany@apache.org>
Committed: Sun Dec 13 15:15:45 2015 +0100

----------------------------------------------------------------------
 src/main/java/freemarker/template/Template.java | 33 +++++++++++---------
 1 file changed, 19 insertions(+), 14 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/2e391962/src/main/java/freemarker/template/Template.java
----------------------------------------------------------------------
diff --git a/src/main/java/freemarker/template/Template.java b/src/main/java/freemarker/template/Template.java
index 5750a6c..0530fe2 100644
--- a/src/main/java/freemarker/template/Template.java
+++ b/src/main/java/freemarker/template/Template.java
@@ -354,23 +354,28 @@ public class Template extends Configurable {
     }
 
     /**
-     * Executes template, using the data-model provided, writing the generated output
-     * to the supplied {@link Writer}.
+     * Executes template, using the data-model provided, writing the generated output to
the supplied {@link Writer}.
      * 
-     * <p>For finer control over the runtime environment setup, such as per-HTTP-request
configuring of FreeMarker
-     * settings, you may need to use {@link #createProcessingEnvironment(Object, Writer)}
instead. 
+     * <p>
+     * For finer control over the runtime environment setup, such as per-HTTP-request configuring
of FreeMarker
+     * settings, you may need to use {@link #createProcessingEnvironment(Object, Writer)}
instead.
      * 
-     * @param dataModel the holder of the variables visible from the template (name-value
pairs); usually a
-     *     {@code Map<String, Object>} or a JavaBean (where the JavaBean properties
will be the variables).
-     *     Can be any object that the {@link ObjectWrapper} in use turns into a {@link TemplateHashModel}.
-     *     You can also use an object that already implements {@link TemplateHashModel};
in that case it won't be
-     *     wrapped. If it's {@code null}, an empty data model is used.
-     * @param out The {@link Writer} where the output of the template will go. Note that
unless you have used
-     *    {@link Configuration#setAutoFlush(boolean)} to disable this, {@link Writer#flush()}
will be called at the
-     *    when the template processing was finished. {@link Writer#close()} is not called.
+     * @param dataModel
+     *            the holder of the variables visible from the template (name-value pairs);
usually a
+     *            {@code Map<String, Object>} or a JavaBean (where the JavaBean properties
will be the variables). Can
+     *            be any object that the {@link ObjectWrapper} in use turns into a {@link
TemplateHashModel}. You can
+     *            also use an object that already implements {@link TemplateHashModel}; in
that case it won't be
+     *            wrapped. If it's {@code null}, an empty data model is used.
+     * @param out
+     *            The {@link Writer} where the output of the template will go. Note that
unless you have used
+     *            {@link Configuration#setAutoFlush(boolean)} to disable this, {@link Writer#flush()}
will be called at
+     *            the when the template processing was finished. {@link Writer#close()} is
not called. Can't be
+     *            {@code null}.
      * 
-     * @throws TemplateException if an exception occurs during template processing
-     * @throws IOException if an I/O exception occurs during writing to the writer.
+     * @throws TemplateException
+     *             if an exception occurs during template processing
+     * @throws IOException
+     *             if an I/O exception occurs during writing to the writer.
      */
     public void process(Object dataModel, Writer out)
     throws TemplateException, IOException {


Mime
View raw message