freemarker-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ddek...@apache.org
Subject [14/19] incubator-freemarker git commit: (JavaDoc improvements)
Date Fri, 25 Aug 2017 23:39:40 GMT
(JavaDoc improvements)


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

Branch: refs/heads/2.3
Commit: e395401297b57e9208e4f17bffbb7731bc77b75a
Parents: 0213afa
Author: ddekany <ddekany@apache.org>
Authored: Sat Aug 26 00:26:36 2017 +0200
Committer: ddekany <ddekany@apache.org>
Committed: Sat Aug 26 00:26:36 2017 +0200

----------------------------------------------------------------------
 src/main/java/freemarker/ext/beans/BeanModel.java       |  2 +-
 .../freemarker/template/TemplateCollectionModel.java    | 12 ++++++++----
 .../freemarker/template/TemplateCollectionModelEx.java  |  4 ++--
 3 files changed, 11 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/e3954012/src/main/java/freemarker/ext/beans/BeanModel.java
----------------------------------------------------------------------
diff --git a/src/main/java/freemarker/ext/beans/BeanModel.java b/src/main/java/freemarker/ext/beans/BeanModel.java
index f9b56c7..8ec19ea 100644
--- a/src/main/java/freemarker/ext/beans/BeanModel.java
+++ b/src/main/java/freemarker/ext/beans/BeanModel.java
@@ -119,7 +119,7 @@ implements
      * matching the key name. If a method or property is found, it's wrapped
      * into {@link freemarker.template.TemplateMethodModelEx} (for a method or
      * indexed property), or evaluated on-the-fly and the return value wrapped
-     * into appropriate model (for a simple property) Models for various
+     * into appropriate model (for a non-indexed property) Models for various
      * properties and methods are cached on a per-class basis, so the costly
      * introspection is performed only once per property or method of a class.
      * (Side-note: this also implies that any class whose method has been called

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/e3954012/src/main/java/freemarker/template/TemplateCollectionModel.java
----------------------------------------------------------------------
diff --git a/src/main/java/freemarker/template/TemplateCollectionModel.java b/src/main/java/freemarker/template/TemplateCollectionModel.java
index f6662af..4bd21f8 100644
--- a/src/main/java/freemarker/template/TemplateCollectionModel.java
+++ b/src/main/java/freemarker/template/TemplateCollectionModel.java
@@ -23,10 +23,14 @@ import java.util.Collection;
 
 /**
  * "collection" template language data type: a collection of values that can be enumerated,
but can't be or not meant to
- * be accessed by index or key. As such, this is not a super-interface of {@link TemplateSequenceModel},
and
- * implementations of that interface needn't also implement this interface just because they
can. They should though, if
- * enumeration with this interface is significantly faster than enumeration by index. The
{@code #list} directive will
- * enumerate using this interface if it's available.
+ * be accessed by index or key, nor the number of elements in it is known. As such, this
is very similar to Java's
+ * {@link Iterable} interface (but it predates that interface, hence the unfortunate class
name).
+ * 
+ * <p>
+ * Note that this is not a super-interface of {@link TemplateSequenceModel}, and implementations
of that interface
+ * needn't also implement this interface just because they can. They should though, if enumeration
with this interface
+ * is significantly faster than enumeration by index. The {@code #list} directive will enumerate
using this interface if
+ * it's available.
  * 
  * <p>
  * The enumeration should be repeatable if that's possible with reasonable effort, otherwise
a second enumeration

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/e3954012/src/main/java/freemarker/template/TemplateCollectionModelEx.java
----------------------------------------------------------------------
diff --git a/src/main/java/freemarker/template/TemplateCollectionModelEx.java b/src/main/java/freemarker/template/TemplateCollectionModelEx.java
index 266c209..f089abf 100644
--- a/src/main/java/freemarker/template/TemplateCollectionModelEx.java
+++ b/src/main/java/freemarker/template/TemplateCollectionModelEx.java
@@ -22,8 +22,8 @@ package freemarker.template;
 import java.util.Collection;
 
 /**
- * "extended collection" template language data type: Adds size/emptiness querybility and
"contains" test to
- * {@link TemplateCollectionModel}. The added extra operations is provided by all Java {@link
Collection}-s, and this
+ * "collection" template language data type: Adds size/emptiness querybility to
+ * {@link TemplateCollectionModel}. The added extra operations are provided by all Java {@link
Collection}-s, and this
  * interface was added to make that accessible for templates too.
  * 
  * @since 2.3.22


Mime
View raw message