freemarker-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ddek...@apache.org
Subject [25/50] [abbrv] incubator-freemarker git commit: (JavaDoc fixes)
Date Wed, 01 Mar 2017 14:21:23 GMT
(JavaDoc fixes)


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

Branch: refs/heads/2.3
Commit: 148d8c21329b5e742a7c32c3f293517ea1931883
Parents: 870f0a7
Author: ddekany <ddekany@apache.org>
Authored: Fri Feb 24 18:49:52 2017 +0100
Committer: ddekany <ddekany@apache.org>
Committed: Fri Feb 24 18:49:52 2017 +0100

----------------------------------------------------------------------
 src/main/java/freemarker/core/MarkupOutputFormat.java |  8 ++++----
 src/main/java/freemarker/core/OutputFormat.java       | 14 +++++++-------
 2 files changed, 11 insertions(+), 11 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/148d8c21/src/main/java/freemarker/core/MarkupOutputFormat.java
----------------------------------------------------------------------
diff --git a/src/main/java/freemarker/core/MarkupOutputFormat.java b/src/main/java/freemarker/core/MarkupOutputFormat.java
index b058591..39eaaca 100644
--- a/src/main/java/freemarker/core/MarkupOutputFormat.java
+++ b/src/main/java/freemarker/core/MarkupOutputFormat.java
@@ -31,10 +31,10 @@ import freemarker.template.TemplateModelException;
  * {@link Configuration#setOutputFormat(OutputFormat)}.)
  * 
  * <p>
- * An {@link OutputFormat} subclass always has a corresponding {@link TemplateMarkupOutputModel}
subclass pair (like
- * {@link HTMLOutputFormat} has {@link TemplateHTMLOutputModel}). The {@link OutputFormat}
implements the operations
- * related to {@link TemplateMarkupOutputModel} objects of that kind, while the {@link TemplateMarkupOutputModel}
only
- * encapsulates the data (the actual markup or text).
+ * A {@link MarkupOutputFormat} subclass always has a corresponding {@link TemplateMarkupOutputModel}
subclass pair
+ * (like {@link HTMLOutputFormat} has {@link TemplateHTMLOutputModel}). The {@link OutputFormat}
implements the
+ * operations related to {@link TemplateMarkupOutputModel} objects of that kind, while the
+ * {@link TemplateMarkupOutputModel} only encapsulates the data (the actual markup or text).
  * 
  * <p>
  * To implement a custom output format, you may want to extend {@link CommonMarkupOutputFormat}.

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/148d8c21/src/main/java/freemarker/core/OutputFormat.java
----------------------------------------------------------------------
diff --git a/src/main/java/freemarker/core/OutputFormat.java b/src/main/java/freemarker/core/OutputFormat.java
index 5f4bc60..5a262aa 100644
--- a/src/main/java/freemarker/core/OutputFormat.java
+++ b/src/main/java/freemarker/core/OutputFormat.java
@@ -40,19 +40,19 @@ public abstract class OutputFormat {
     
     /**
      * Returns the MIME type of the output format. This might comes handy when generating
a HTTP response. {@code null}
-     * if this output format doesn't clearly corresponds to a specific MIME type.
+     * {@code null} if this output format doesn't clearly corresponds to a specific MIME
type.
      */
     public abstract String getMimeType();
 
     /**
      * Tells if this output format allows inserting {@link TemplateMarkupOutputModel}-s of
another output formats into
      * it. If {@code true}, the foreign {@link TemplateMarkupOutputModel} will be inserted
into the output as is (like
-     * if the surrounding output format was the same). This is usually a bad idea allow,
as such an event could indicate
-     * application bugs. If this method returns {@code false} (recommended), then FreeMarker
will try to assimilate the
-     * inserted value by converting its format to this format, which will currently (2.3.24)
cause exception, unless the
-     * inserted value is made by escaping plain text and the target format is non-escaping,
in which case format
-     * conversion is trivially possible. (It's not impossible that conversions will be extended
beyond this, if there
-     * will be demand for that.)
+     * if the surrounding output format was the same). This is usually a bad idea to allow,
as such an event could
+     * indicate application bugs. If this method returns {@code false} (recommended), then
FreeMarker will try to
+     * assimilate the inserted value by converting its format to this format, which will
currently (2.3.24) cause
+     * exception, unless the inserted value is made by escaping plain text and the target
format is non-escaping, in
+     * which case format conversion is trivially possible. (It's not impossible that conversions
will be extended beyond
+     * this, if there will be demand for that.)
      * 
      * <p>
      * {@code true} value is used by {@link UndefinedOutputFormat}.


Mime
View raw message