[06/50] [abbrv] incubator-freemarker git commit: (TemplateLoader JavaDoc adjustments)

[dd...@apache.org]

(TemplateLoader JavaDoc adjustments)


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

Branch: refs/heads/2.3
Commit: 23852f0352b8c200bcd4e62f19fb001c8b3ea142
Parents: dd2c6a3
Author: ddekany <dd...@apache.org>
Authored: Sun Feb 5 19:14:32 2017 +0100
Committer: ddekany <dd...@apache.org>
Committed: Sun Feb 5 19:14:32 2017 +0100

----------------------------------------------------------------------
 src/main/java/freemarker/cache/TemplateLoader.java | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/23852f03/src/main/java/freemarker/cache/TemplateLoader.java
----------------------------------------------------------------------
diff --git a/src/main/java/freemarker/cache/TemplateLoader.java b/src/main/java/freemarker/cache/TemplateLoader.java
index bab7cae..014b004 100644
--- a/src/main/java/freemarker/cache/TemplateLoader.java
+++ b/src/main/java/freemarker/cache/TemplateLoader.java
@@ -54,12 +54,12 @@ public interface TemplateLoader {
      * template can be loaded from. See the return value for more information.
      *
      * @param name
-     *            The name of the template, already localized and normalized by the
-     *            {@link freemarker.cache.TemplateCache cache}. It is completely up to the loader implementation to
+     *            The name (template root directory relative path) of the template, already localized and normalized by
+     *            the {@link freemarker.cache.TemplateCache cache}. It is completely up to the loader implementation to
      *            interpret the name, however it should expect to receive hierarchical paths where path components are
      *            separated by a slash (not backslash). Backslashes (or any other OS specific separator character) are
      *            not considered as separators by FreeMarker, and thus they will not be replaced with slash before
-     *            passing to this method, so it's up to the template loader to handle them (say, be throwing and
+     *            passing to this method, so it's up to the template loader to handle them (say, by throwing an
      *            exception that tells the user that the path (s)he has entered is invalid, as (s)he must use slash --
      *            typical mistake of Windows users). The passed names are always considered relative to some
      *            loader-defined root location (often referred as the "template root directory"), and will never start
@@ -133,8 +133,7 @@ public interface TemplateLoader {
      * @throws IOException
      *             if an I/O error occurs while accessing the stream.
      */
-    public Reader getReader(Object templateSource, String encoding)
-    throws IOException;
+    public Reader getReader(Object templateSource, String encoding) throws IOException;
     
     /**
      * Closes the template source, releasing any resources held that are only required for reading the template and/or
@@ -145,6 +144,6 @@ public interface TemplateLoader {
      * @param templateSource
      *            the template source that should be closed.
      */
-    public void closeTemplateSource(Object templateSource)
-    throws IOException;
+    public void closeTemplateSource(Object templateSource) throws IOException;
+    
 }