freemarker-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ddek...@apache.org
Subject incubator-freemarker git commit: (JavaDoc clarification)
Date Tue, 13 Jun 2017 12:30:47 GMT
Repository: incubator-freemarker
Updated Branches:
  refs/heads/3 5799df34e -> e78181a1c


(JavaDoc clarification)


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

Branch: refs/heads/3
Commit: e78181a1ccbdde7a71f8cec4946a216eccce798f
Parents: 5799df3
Author: ddekany <ddekany@apache.org>
Authored: Tue Jun 13 14:30:41 2017 +0200
Committer: ddekany <ddekany@apache.org>
Committed: Tue Jun 13 14:30:41 2017 +0200

----------------------------------------------------------------------
 .../java/org/apache/freemarker/core/Template.java  | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/e78181a1/freemarker-core/src/main/java/org/apache/freemarker/core/Template.java
----------------------------------------------------------------------
diff --git a/freemarker-core/src/main/java/org/apache/freemarker/core/Template.java b/freemarker-core/src/main/java/org/apache/freemarker/core/Template.java
index f134675..0126d60 100644
--- a/freemarker-core/src/main/java/org/apache/freemarker/core/Template.java
+++ b/freemarker-core/src/main/java/org/apache/freemarker/core/Template.java
@@ -591,14 +591,15 @@ public class Template implements ProcessingConfiguration, CustomStateScope
{
 
     /**
      * The name that was actually used to load this template from the {@link TemplateLoader}
(or from other custom
-     * storage mechanism). This is what should be shown in error messages as the error location.
This is usually the
-     * same as {@link #getLookupName()}, except when localized template lookup, template
acquisition ({@code *} step
-     * in the name), or other {@link TemplateLookupStrategy} transforms the requested name
({@link #getLookupName()})
-     * to a different final {@link TemplateLoader}-level name. For example, when you get
a template with name {@code
-     * "foo .ftl"} then because of localized template lookup, it's possible that something
like {@code "foo_en.ftl"}
-     * will be loaded behind the scenes. While the template name will be still the same as
the requested template
-     * name ({@code "foo .ftl"}), errors should point to {@code "foo_de.ftl"}. Note that
relative paths are always
-     * resolved relatively to the {@code name}, not to the {@code sourceName}.
+     * storage mechanism), or possibly {@code null} for non-stored templates. This is what
should be shown in error
+     * messages as the error location. This is usually the same as {@link #getLookupName()},
except when localized
+     * template lookup, template acquisition ({@code *} step in the name), or other {@link
TemplateLookupStrategy}
+     * transforms the requested name ({@link #getLookupName()}) to a different final {@link
TemplateLoader}-level
+     * name. For example, when you get a template with name {@code "foo .ftl"} then because
of localized template
+     * lookup, it's possible that something like {@code "foo_en.ftl"} will be loaded behind
the scenes. While the
+     * template name will be still the same as the requested template name ({@code "foo .ftl"}),
errors should point
+     * to {@code "foo_de.ftl"}. Note that relative paths are always resolved relatively to
the {@code name}, not to
+     * the {@code sourceName}.
      */
     public String getSourceName() {
         return sourceName;


Mime
View raw message