freemarker-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ddek...@apache.org
Subject [6/9] incubator-freemarker git commit: FREEMARKER-55: fixing javadocs
Date Thu, 14 Sep 2017 09:14:15 GMT
FREEMARKER-55: fixing javadocs


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

Branch: refs/heads/3
Commit: ed955cee700fc162568ae944cc6db516ebcd092c
Parents: 3c25f7a
Author: Woonsan Ko <woonsan@apache.org>
Authored: Wed Sep 13 21:35:06 2017 -0400
Committer: Woonsan Ko <woonsan@apache.org>
Committed: Wed Sep 13 21:35:06 2017 -0400

----------------------------------------------------------------------
 .../spring/SpringResourceTemplateLoader.java     | 19 ++++---------------
 .../spring/web/view/PageContextServlet.java      |  4 ++--
 2 files changed, 6 insertions(+), 17 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/ed955cee/freemarker-spring/src/main/java/org/apache/freemarker/spring/SpringResourceTemplateLoader.java
----------------------------------------------------------------------
diff --git a/freemarker-spring/src/main/java/org/apache/freemarker/spring/SpringResourceTemplateLoader.java
b/freemarker-spring/src/main/java/org/apache/freemarker/spring/SpringResourceTemplateLoader.java
index bf430b7..c8bee0b 100644
--- a/freemarker-spring/src/main/java/org/apache/freemarker/spring/SpringResourceTemplateLoader.java
+++ b/freemarker-spring/src/main/java/org/apache/freemarker/spring/SpringResourceTemplateLoader.java
@@ -54,7 +54,8 @@ public class SpringResourceTemplateLoader implements TemplateLoader, ResourceLoa
     private ResourceLoader resourceLoader;
 
     /**
-     * Base resource location which can be prepended to the template name internally when
resolving a resource.
+     * Return base resource location which can be prepended to the template name internally
when resolving a resource.
+     * @return base resource location which can be prepended to the template name internally
when resolving a resource
      */
     public String getBaseLocation() {
         return baseLocation;
@@ -62,31 +63,22 @@ public class SpringResourceTemplateLoader implements TemplateLoader, ResourceLoa
 
     /**
      * Set base resource location which can be prepended to the template name internally
when resolving a resource.
-     * @param baseLocation
+     * @param baseLocation base resource location which can be prepended to the template
name internally when resolving a resource
      */
     public void setBaseLocation(String baseLocation) {
         this.baseLocation = baseLocation;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public void setResourceLoader(ResourceLoader resourceLoader) {
         this.resourceLoader = resourceLoader;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public TemplateLoaderSession createSession() {
         return null;
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public TemplateLoadingResult load(String name, TemplateLoadingSource ifSourceDiffersFrom,
             Serializable ifVersionDiffersFrom, TemplateLoaderSession session) throws IOException
{
@@ -129,12 +121,9 @@ public class SpringResourceTemplateLoader implements TemplateLoader,
ResourceLoa
         return new TemplateLoadingResult(source, version, resource.getInputStream(), null);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public void resetState() {
-        // Does nothing
+        // Do nothing
     }
 
     @SuppressWarnings("serial")

http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/ed955cee/freemarker-spring/src/main/java/org/apache/freemarker/spring/web/view/PageContextServlet.java
----------------------------------------------------------------------
diff --git a/freemarker-spring/src/main/java/org/apache/freemarker/spring/web/view/PageContextServlet.java
b/freemarker-spring/src/main/java/org/apache/freemarker/spring/web/view/PageContextServlet.java
index 7b8e923..97f4321 100644
--- a/freemarker-spring/src/main/java/org/apache/freemarker/spring/web/view/PageContextServlet.java
+++ b/freemarker-spring/src/main/java/org/apache/freemarker/spring/web/view/PageContextServlet.java
@@ -27,8 +27,8 @@ import javax.servlet.ServletResponse;
 
 /**
  * A built-in internal servlet class to be used as page object in JSP tag libraries used
in FreeMarker templates.
- *
- * @see javax.servlet.jsp.PageContext#getPage()
+ * JSP Tag Library implementations may invoke <code>javax.servlet.jsp.PageContext#getPage()</code>
to get the
+ * reference of the servlet. So, this internal servlet implementation is provided for that.
  */
 @SuppressWarnings("serial")
 final class PageContextServlet extends GenericServlet {


Mime
View raw message