velocity-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cbris...@apache.org
Subject svn commit: r1842523 - in /velocity/tools/trunk: velocity-tools-generic/src/main/java/org/apache/velocity/tools/ velocity-tools-generic/src/main/java/org/apache/velocity/tools/config/ velocity-tools-generic/src/main/java/org/apache/velocity/tools/gener...
Date Mon, 01 Oct 2018 17:27:16 GMT
Author: cbrisson
Date: Mon Oct  1 17:27:15 2018
New Revision: 1842523

URL: http://svn.apache.org/viewvc?rev=1842523&view=rev
Log:
[tools] Still some javadoc fixes

Modified:
    velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/ToolboxFactory.java
    velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/config/ConfigurationUtils.java
    velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/config/FactoryConfiguration.java
    velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/generic/LoopTool.java
    velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/generic/ResourceTool.java
    velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/generic/XmlTool.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/AbstractSearchTool.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/BrowserTool.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/BrowserToolDeprecatedMethods.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/CookieTool.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/IncludeTool.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/JsonTool.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/LinkTool.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/PagerTool.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ParameterTool.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ServletUtils.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/UiDependencyTool.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityLayoutServlet.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityView.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityViewFilter.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityViewServlet.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewContext.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewImportSupport.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewToolContext.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewToolManager.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/WebappUberspector.java
    velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/XmlTool.java

Modified: velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/ToolboxFactory.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/ToolboxFactory.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/ToolboxFactory.java (original)
+++ velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/ToolboxFactory.java Mon Oct  1 17:27:15 2018
@@ -47,8 +47,8 @@ import org.apache.velocity.tools.config.
  * <p>
  * Of course, most users will not have to do any of this
  * as much of it is handled for them by some combination of 
- * {@link ToolManager} or {@link org.apache.velocity.tools.view.VelocityView}
- * and a {@link ToolContext} or {@link org.apache.velocity.tools.view.ViewToolContext}.
+ * {@link ToolManager} or org.apache.velocity.tools.view.VelocityView
+ * and a {@link ToolContext} or org.apache.velocity.tools.view.ViewToolContext.
  * </p><p>
  * <strong>NOTE:</strong> While you are free to pass in new configuration info
  * at any time, that data will only affect {@link Toolbox}es created subsequently.

Modified: velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/config/ConfigurationUtils.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/config/ConfigurationUtils.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/config/ConfigurationUtils.java (original)
+++ velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/config/ConfigurationUtils.java Mon Oct  1 17:27:15 2018
@@ -107,7 +107,7 @@ public class ConfigurationUtils
     /**
      * <p>Returns a {@link FactoryConfiguration} including all default
      * "VelocityView" tools available as well as the default "GenericTools".</p>
-     * @return all default tools {@link ConfigurationFactory}
+     * @return all default tools {@link FactoryConfiguration}
      * @throws ConfigurationException if a tools.xml is not found at the {@link #VIEW_DEFAULTS_PATH}.
      */
     public static FactoryConfiguration getVelocityView()
@@ -162,7 +162,7 @@ public class ConfigurationUtils
      * Convenience method that automatically creates a new
      * {@link ConfigurationCleaner} and applies it to the specified
      * {@link Configuration}.
-     * @param config {@link configuration}
+     * @param config {@link Configuration}
      */
     public static void clean(Configuration config)
     {
@@ -178,7 +178,7 @@ public class ConfigurationUtils
      * will throw a {@link ResourceNotFoundException}.
      *
      * @param path configuration path
-     * @return new {@linkFactoryConfiguration}
+     * @return new {@link FactoryConfiguration}
      * @see #find(String path)
      */
     public static FactoryConfiguration load(String path)

Modified: velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/config/FactoryConfiguration.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/config/FactoryConfiguration.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/config/FactoryConfiguration.java (original)
+++ velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/config/FactoryConfiguration.java Mon Oct  1 17:27:15 2018
@@ -76,7 +76,7 @@ public class FactoryConfiguration
     /**
      * Creates a new instance with the specified source name
      * combined with this class's name as the initial source.
-     * @param source configuration source
+     * @param source configuration source name
      */
     public FactoryConfiguration(String source)
     {
@@ -86,6 +86,7 @@ public class FactoryConfiguration
     /**
      * Allows subclasses to construct an instance that uses their classname.
      * @param clazz FactoryConfiguration class name
+     * @param source configuration source name
      */
     protected FactoryConfiguration(Class clazz, String source)
     {
@@ -104,7 +105,7 @@ public class FactoryConfiguration
     /**
      * Sets the name of the original source of this particular instance.
      * This does not affect subsequently added sources.
-     * @param source configuration source
+     * @param source configuration source name
      */
     public void setSource(String source)
     {
@@ -158,7 +159,7 @@ public class FactoryConfiguration
 
     /**
      * Search for Data by key
-     * @param datum key of data to get
+     * @param key key of data to get
      * @return found Data or null
      */
     public Data getData(String key)

Modified: velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/generic/LoopTool.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/generic/LoopTool.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/generic/LoopTool.java (original)
+++ velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/generic/LoopTool.java Mon Oct  1 17:27:15 2018
@@ -815,7 +815,7 @@ public class LoopTool extends SafeConfig
          * @return the parallel value from the specified sync'ed iterator.
          * If no sync'ed iterator exists with that name or that iterator
          * is finished, this will return {@code null}.
-         * @param iterator name
+         * @param name iterator name
          * @return iterator current value
          */
         public Object get(String name)

Modified: velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/generic/ResourceTool.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/generic/ResourceTool.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/generic/ResourceTool.java (original)
+++ velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/generic/ResourceTool.java Mon Oct  1 17:27:15 2018
@@ -53,7 +53,7 @@ import org.apache.velocity.tools.config.
  *
  * <p>This comes in very handy when internationalizing templates.
  *    Note that the default resource bundle baseName is "resources", and
- *    the default locale is either:<p>
+ *    the default locale is either:</p>
  * <ul>
  *    <li>the result of HttpServletRequest.getLocale() (if used in request scope
  *          of a VelocityView app)</li>
@@ -121,7 +121,7 @@ public class ResourceTool extends Locale
 
     /**
      * Accepts objects and uses their string value as the key.
-     * @param k key
+     * @param key key
      * @return Key object
      */
     public Key get(String key)

Modified: velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/generic/XmlTool.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/generic/XmlTool.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/generic/XmlTool.java (original)
+++ velocity/tools/trunk/velocity-tools-generic/src/main/java/org/apache/velocity/tools/generic/XmlTool.java Mon Oct  1 17:27:15 2018
@@ -146,7 +146,7 @@ public class XmlTool extends SafeConfig
 
     /**
      * Builds an XmlTool around a node.
-     * @param node
+     * @param node target node
      */
     public XmlTool(Node node)
     {
@@ -155,7 +155,7 @@ public class XmlTool extends SafeConfig
 
     /**
      * Builds an XmlTool around a nodes list.
-     * @param nodes
+     * @param nodes nodes list
      */
     public XmlTool(List<Node> nodes)
     {
@@ -246,7 +246,7 @@ public class XmlTool extends SafeConfig
     /**
      * Reads and parses a remote or local URL
      * @param url resource URL
-     * @ return new XmlTool
+     * @return new XmlTool
      */
     public XmlTool fetch(String url)
     {
@@ -488,6 +488,7 @@ public class XmlTool extends SafeConfig
     /**
      * Returns an {@link XmlTool} that wraps the specified
      * {@link Node} from this instance's internal Node list.
+     * @param n node index in current nodes list
      * @return a wrapper on the nth node or null
      */
     public XmlTool get(Number n)

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/AbstractSearchTool.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/AbstractSearchTool.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/AbstractSearchTool.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/AbstractSearchTool.java Mon Oct  1 17:27:15 2018
@@ -269,7 +269,7 @@ public abstract class AbstractSearchTool
      * Executes a query for the specified criteria.
      *
      * <p>This method must be implemented! A simple
-     * implementation might be something like:
+     * implementation might be something like:</p>
      * <pre>
      * protected List executeQuery(Object crit)
      * {
@@ -277,6 +277,7 @@ public abstract class AbstractSearchTool
      * }
      * </pre>
      *
+     * @param criteria search criteria
      * @return a {@link List} of results for this query
      */
     protected abstract List executeQuery(Object criteria);

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/BrowserTool.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/BrowserTool.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/BrowserTool.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/BrowserTool.java Mon Oct  1 17:27:15 2018
@@ -35,7 +35,6 @@ import javax.servlet.http.HttpServletReq
 
 /**
  *  <p>Browser sniffing tool (session or request scope requested, session scope advised).</p>
- *  <p></p>
  * <p><b>Usage:</b></p>
  * <p>BrowserTool defines properties that are used to test the client browser, operating system, device, language...</p>
  * <p>All properties are boolean, excpet those in italic which are strings (and major/minor versions which are integers)</p>
@@ -117,6 +116,7 @@ public class BrowserTool extends Browser
 
     /**
      * Retrieves the User-Agent header from the request (if any).
+     * @param request servlet request
      * @see #setUserAgentString
      */
     public void setRequest(HttpServletRequest request)
@@ -151,6 +151,7 @@ public class BrowserTool extends Browser
      * will be empty and everything will return false or null.  Otherwise,
      * it will set the whole string to lower case before storing to simplify
      * parsing.
+     * @param ua user agent string
      */
     public void setUserAgentString(String ua)
     {
@@ -250,6 +251,7 @@ public class BrowserTool extends Browser
     /* device type */
 
     /**
+     * @return found device
      * @since VelocityTools 3.0
      */
     public String getDevice()
@@ -263,6 +265,7 @@ public class BrowserTool extends Browser
     }
 
     /**
+     * @return whether found device is a tablet
      * @since VelocityTools 3.0
      */
     public boolean isTablet()
@@ -271,6 +274,7 @@ public class BrowserTool extends Browser
     }
 
     /**
+     * @return whether found device is a mobile device
      * @since VelocityTools 3.0
      */
     public boolean isMobile()
@@ -279,6 +283,7 @@ public class BrowserTool extends Browser
     }
 
     /**
+     * @return whether found device is a desktop device
      * @since VelocityTools 3.0
      */
     public boolean isDesktop()
@@ -287,6 +292,7 @@ public class BrowserTool extends Browser
     }
 
     /**
+     * @return whether found device is a TV
      * @since VelocityTools 3.0
      */
     public boolean isTV()
@@ -295,6 +301,7 @@ public class BrowserTool extends Browser
     }
 
     /**
+     * @return parsed browser
      * @since VelocityTools 3.0
      */
     public UAEntity getBrowser()
@@ -303,6 +310,7 @@ public class BrowserTool extends Browser
     }
 
     /**
+     * @return parsed rendering engine
      * @since VelocityTools 3.0
      */
     public UAEntity getRenderingEngine()
@@ -311,6 +319,7 @@ public class BrowserTool extends Browser
     }
 
     /**
+     * @return parsed operating system
      * @since VelocityTools 3.0
      */
     public UAEntity getOperatingSystem()

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/BrowserToolDeprecatedMethods.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/BrowserToolDeprecatedMethods.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/BrowserToolDeprecatedMethods.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/BrowserToolDeprecatedMethods.java Mon Oct  1 17:27:15 2018
@@ -26,45 +26,30 @@ public abstract class BrowserToolDepreca
     public abstract boolean isLinux();
     protected abstract boolean test(String str);
 
-    /**
-     * @deprecated use {@link #getBrowser()}.getUserAgentString()
-     */
     @Deprecated
     public String getUserAgent()
     {
         return getUserAgentString();
     }
     
-    /**
-     * @deprecated use {@link #getBrowser()} version getters
-     */
     @Deprecated
     public String getVersion()
     {
         return getBrowser().getMajorVersion() + "." + getBrowser().getMinorVersion();
     }
 
-    /**
-     * @deprecated use {@link #getBrowser()}.getMajorVersion()
-     */
     @Deprecated
     public int getMajorVersion()
     {
         return getBrowser().getMajorVersion();
     }
 
-    /**
-     * @deprecated use {@link #getBrowser()}.getMinorVersion()
-     */
     @Deprecated
     public int getMinorVersion()
     {
         return getBrowser().getMinorVersion();
     }
 
-    /**
-     * @deprecated use {@link #getRenderingEngine()} and version getters
-     */
     @Deprecated
     public String getGeckoVersion()
     {
@@ -75,9 +60,7 @@ public abstract class BrowserToolDepreca
                         null;
     }
 
-    /**
-     * @deprecated use {@link #getRenderingEngine()} and version getters
-     */
+    @Deprecated
     public int getGeckoMajorVersion()
     {
         UAEntity renderingEngine = getRenderingEngine();
@@ -87,9 +70,7 @@ public abstract class BrowserToolDepreca
                         0;
     }
 
-    /**
-     * @deprecated use {@link #getRenderingEngine()} version getters
-     */
+    @Deprecated
     public int getGeckoMinorVersion()
     {
         UAEntity renderingEngine = getRenderingEngine();
@@ -99,350 +80,263 @@ public abstract class BrowserToolDepreca
                         0;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getNav2()
     {
         return isNetscape() && getBrowser().getMajorVersion() == 2;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getNav3()
     {
         return isNetscape() && getMajorVersion() == 3;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getNav4()
     {
         return isNetscape() && getMajorVersion() == 4;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getNav4up()
     {
         return isNetscape() && getMajorVersion() >= 4;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getNav45()
     {
         return isNetscape() && getMajorVersion() == 4 &&
                 getMinorVersion() == 5;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getNav45up()
     {
         return isNetscape() && getMajorVersion() >= 5 ||
                 getNav4() && getMinorVersion() >= 5;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getNavgold()
     {
         return test("gold");
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getNav6()
     {
         return isNetscape() && getMajorVersion() == 5; /* sic */
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getNav6up()
     {
         return isNetscape() && getMajorVersion() >= 5;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getIe()
     {
         return isMSIE();
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getIe3()
     {
         return isMSIE() && getBrowser().getMajorVersion() < 4;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getIe4()
     {
         return isMSIE() && getBrowser().getMajorVersion() == 4;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getIe4up()
     {
         return isMSIE() && getBrowser().getMajorVersion() >= 4;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getIe5()
     {
         return isMSIE() && getBrowser().getMajorVersion() == 5;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getIe5up()
     {
         return isMSIE() && getBrowser().getMajorVersion() >= 5;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getIe55()
     {
         return isMSIE() && getBrowser().getMajorVersion() == 5 && getBrowser().getMinorVersion() >= 5;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getIe55up()
     {
         return (getIe5() && getBrowser().getMinorVersion() >= 5) ||
                 (isMSIE() && getBrowser().getMajorVersion() >= 6);
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getIe6()
     {
         return isMSIE() && getBrowser().getMajorVersion() == 6;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getIe6up()
     {
         return isMSIE() && getBrowser().getMajorVersion() >= 6;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getIe7()
     {
         return isMSIE() && getBrowser().getMajorVersion() == 7;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getIe7up()
     {
         return isMSIE() && getBrowser().getMajorVersion() >= 7;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getIe8()
     {
         return isMSIE() && getBrowser().getMajorVersion() == 8;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getIe8up()
     {
         return isMSIE() && getBrowser().getMajorVersion() >= 8;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getOpera3()
     {
         return isOpera() && getBrowser().getMajorVersion() == 3;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getOpera4()
     {
         return isOpera() && getBrowser().getMajorVersion() == 4;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getOpera5()
     {
         return isOpera() && getBrowser().getMajorVersion() == 5;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getOpera6()
     {
         return isOpera() && getBrowser().getMajorVersion() == 6;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getOpera7()
     {
         return isOpera() && getBrowser().getMajorVersion() == 7;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getOpera8()
     {
         return isOpera() && getBrowser().getMajorVersion() == 8;
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getOpera9()
     {
         return test("opera/9");
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getWin16()
     {
         return test("win16") || test("16bit") || test("windows 3") ||
                 test("windows 16-bit");
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getWin3x()
     {
         return test("win16") || test("windows 3") || test("windows 16-bit");
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getWin31()
     {
         return test("win16") || test("windows 3.1") || test("windows 16-bit");
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getWin95()
     {
         return test("win95") || test("windows 95");
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getWin98()
     {
         return test("win98") || test("windows 98");
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getWinnt()
     {
         return test("winnt") || test("windows nt") || test("nt4") || test("nt3");
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getWin2k()
     {
         return test("nt 5.0") || test("nt5");
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getWinxp()
     {
         return test("nt 5.1");
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getVista()
     {
         return test("nt 6.0");
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getDotnet()
     {
         return test(".net clr");
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getWinme()
     {
         return test("win 9x 4.90");
     }
 
-    /**
-     * @deprecated
-     */
+    @Deprecated
     public boolean getWin32()
     {
         return getWin95() || getWin98() || getWinnt() || getWin2k() ||
                 getWinxp() || getWinme() || test("win32");
     }
 
-    /**
-     * @deprecated use isOSX()
-     */
     @Deprecated
     public boolean isMac()
     {

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/CookieTool.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/CookieTool.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/CookieTool.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/CookieTool.java Mon Oct  1 17:27:15 2018
@@ -73,6 +73,7 @@ public class CookieTool extends SafeConf
      * Sets the current {@link HttpServletRequest}. This is required
      * for this tool to operate and will throw a NullPointerException
      * if this is not set or is set to {@code null}.
+     * @param request servlet request
      */
     public void setRequest(HttpServletRequest request)
     {
@@ -87,6 +88,7 @@ public class CookieTool extends SafeConf
      * Sets the current {@link HttpServletResponse}. This is required
      * for this tool to operate and will throw a NullPointerException
      * if this is not set or is set to {@code null}.
+     * @param response servlet response
      */
     public void setResponse(HttpServletResponse response)
     {
@@ -131,6 +133,8 @@ public class CookieTool extends SafeConf
      * <p>So, if you had a cookie named 'foo', you'd get it's value
      * by <code>$cookies.foo.value</code> or it's max age
      * by <code>$cookies.foo.maxAge</code></p>
+     * @param name cookie name
+     * @return found cookie or null
      */
     public Cookie get(String name)
     {

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/IncludeTool.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/IncludeTool.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/IncludeTool.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/IncludeTool.java Mon Oct  1 17:27:15 2018
@@ -108,6 +108,9 @@ public class IncludeTool extends SafeCon
      * Calls {@link #find(String, String)} using the
      * language extracted from <code>locale</code>.
      *
+     * @param name resource filename
+     * @param locale locale
+     * @return locallized resource filename
      * @see #find(String, String)
      */
     public String find(String name, Locale locale)
@@ -123,6 +126,8 @@ public class IncludeTool extends SafeCon
      * Calls {@link #find(String, String)} using the
      * default language.
      *
+     * @param name resource filename
+     * @return locallized resource filename
      * @see #find(String, String)
      */
     public String find(String name)
@@ -187,6 +192,8 @@ public class IncludeTool extends SafeCon
      * #end
      * </pre>
      *
+     * @param name resource filename
+     * @return whether resource exists
      * @see VelocityEngine#resourceExists
      */
     public boolean exists(String name)
@@ -207,6 +214,9 @@ public class IncludeTool extends SafeCon
      * Checks to see whether a localized version of the
      * named template exists for the specified language.
      *
+     * @param name resource filename
+     * @param language asked language
+     * @return whether resource exists
      * @see #exists(String)
      */
     public boolean exists(String name, String language)

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/JsonTool.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/JsonTool.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/JsonTool.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/JsonTool.java Mon Oct  1 17:27:15 2018
@@ -45,7 +45,7 @@ public class JsonTool extends org.apache
 
     /**
      * Importsupport initialization
-     * @param config
+     * @param config configuration values
      */
     @Override
     protected synchronized void initializeImportSupport(ValueParser config)
@@ -59,7 +59,7 @@ public class JsonTool extends org.apache
 
     /**
      * Check if a given mime type is of JSON type
-     * @param mimeType
+     * @param mimeType mime type
      * @return whether given mime type is of JSON type
      */
     protected static boolean isJsonMimeType(String mimeType)
@@ -74,7 +74,7 @@ public class JsonTool extends org.apache
 
     /**
      * Configuration. Parses request body if appropriate.
-     * @param parser
+     * @param parser configuration values
      */
     protected void configure(ValueParser parser)
     {

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/LinkTool.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/LinkTool.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/LinkTool.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/LinkTool.java Mon Oct  1 17:27:15 2018
@@ -124,6 +124,7 @@ public class LinkTool extends org.apache
     /**
      * <p>Controls whether or not this tool starts off with all parameters
      * from the last request automatically.  Default is false.</p>
+     * @param includeRequestParams whether or not to keep current request params
      */
     public void setIncludeRequestParams(boolean includeRequestParams)
     {
@@ -136,6 +137,7 @@ public class LinkTool extends org.apache
      * If no parameters are specified,
      * then all of the current request's parameters will be added.
      *
+     * @param butOnlyThese curent request parameters to keep
      * @return A LinkTool object with the specified parameters from
      *         the current request added to it or all the params if none specified.
      */
@@ -148,6 +150,7 @@ public class LinkTool extends org.apache
      * Adds all of the current request's parameters to this link's
      * "query data" except for those whose keys match any of the specified strings.
      *
+     * @param ignoreThese curent request parameters to ignore
      * @return A LinkTool object with all of the current request's parameters
      *         added to it, except those specified.
      */
@@ -161,6 +164,7 @@ public class LinkTool extends org.apache
      * "query data" except for those whose keys match any of the specified strings
      * or already have a value set for them in the current instance.
      *
+     * @param ignoreThese curent request parameters to ignore
      * @return A LinkTool object with all of the current request's parameters
      *         added to it, except those specified or those that already have
      *         values.
@@ -242,6 +246,7 @@ public class LinkTool extends org.apache
      * changed (e.g. via a call to {@link #path(Object)}), then this will
      * simply be the first "directory" in the path (i.e. everything from
      * the start up to the second backslash).
+     * @return context path
      * @see #relative(Object)
      */
     @Override
@@ -272,6 +277,7 @@ public class LinkTool extends org.apache
      * {@link #path(Object)}), then this will
      * simply be everything in the path after the {@link #getContextPath()}
      * (i.e. the second "/" in the path and everything after).
+     * @return request path
      */
     public String getRequestPath()
     {
@@ -297,6 +303,7 @@ public class LinkTool extends org.apache
      * This essentially just replaces the full path with
      * the {@link #getContextPath()} and removes the anchor and query
      * data.
+     * @return context URL
      */
     public String getContextURL()
     {
@@ -310,6 +317,7 @@ public class LinkTool extends org.apache
     /**
      * Overrides to use response.encodeURL to get session id into URL
      * if sessions are used but cookies are not supported.
+     * @return final string representation
      */
     @Override
     public String toString()

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/PagerTool.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/PagerTool.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/PagerTool.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/PagerTool.java Mon Oct  1 17:27:15 2018
@@ -132,6 +132,7 @@ public class PagerTool extends SafeConfi
      * Initializes this tool with the specified {@link HttpServletRequest}.
      * This is required for this tool to operate and will throw a
      * NullPointerException if this is not set or is set to {@code null}.
+     * @param request servlet request
      */
     public void setRequest(HttpServletRequest request)
     {
@@ -442,6 +443,7 @@ public class PagerTool extends SafeConfi
     /**
      * Returns the number of pages that can be made from this list
      * given the set number of items per page.
+     * @return number of available pages
      */
     public int getPagesAvailable()
     {
@@ -499,6 +501,7 @@ public class PagerTool extends SafeConfi
 
     /**
      * Returns the total number of items available.
+     * @return number of items
      * @since VelocityTools 1.3
      */
     public int getTotal()

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ParameterTool.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ParameterTool.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ParameterTool.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ParameterTool.java Mon Oct  1 17:27:15 2018
@@ -179,7 +179,7 @@ public class ParameterTool extends Value
     }
 
     /**
-     * Returns the map of all parameters available for the current request.
+     * @return the map of all parameters available for the current request.
      */
     public Map getAll()
     {

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ServletUtils.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ServletUtils.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ServletUtils.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ServletUtils.java Mon Oct  1 17:27:15 2018
@@ -71,6 +71,8 @@ public class ServletUtils
      * Retrieves the path for the specified request regardless of
      * whether this is a direct request or an include by the
      * RequestDispatcher.
+     * @param request servlet request
+     * @return request path
      */
     public static String getPath(HttpServletRequest request)
     {
@@ -98,6 +100,8 @@ public class ServletUtils
      * Returns the shared {@link VelocityView} for the specified
      * {@link ServletConfig}'s context. If one has not yet been created, it
      * will create, store it for future access, and then return it.
+     * @param config servlet config
+     * @return VelocityView instance
      */
     public static VelocityView getVelocityView(ServletConfig config)
     {
@@ -109,6 +113,8 @@ public class ServletUtils
      * Returns the shared {@link VelocityView} for the specified
      * {@link FilterConfig}'s context. If one has not yet been created, it
      * will create, store it for future access, and then return it.
+     * @param config filter config
+     * @return VelocityView instance
      */
     public static VelocityView getVelocityView(FilterConfig config)
     {
@@ -119,6 +125,8 @@ public class ServletUtils
      * Returns the shared {@link VelocityView} for the specified
      * {@link JeeConfig}'s context. If one has not yet been created, it
      * will create, store it for future access, and then return it.
+     * @param config configuration parameters container (webapp, servlet or filter)
+     * @return VelocityView instance
      */
     public static VelocityView getVelocityView(JeeConfig config)
     {
@@ -190,6 +198,8 @@ public class ServletUtils
      * Returns the shared {@link VelocityView} for the specified
      * {@link ServletContext}. If one has not yet been created,
      * it will create one, store it for future access, and then return it.
+     * @param application servlet context
+     * @return VelocityView instance
      */
     public static VelocityView getVelocityView(ServletContext application)
     {
@@ -201,6 +211,9 @@ public class ServletUtils
      * {@link ServletContext}. If one has not yet been created and
      * the second parameter is <code>true</code>, then it will
      * create one, store it for future access, and return it.
+     * @param application servlet context
+     * @param createIfMissing whether to create VelocityView if not yet built
+     * @return VelocityView instance
      */
     public static VelocityView getVelocityView(ServletContext application,
                                                boolean createIfMissing) {
@@ -435,6 +448,10 @@ public class ServletUtils
      * Returns a mutex (lock object) unique to the specified session
      * and stored under the specified key to allow for reliable
      * synchronization on the session.
+     * @param session HTTP session
+     * @param key mutex key
+     * @param caller caller object
+     * @return session mutex object
      */
     public static Object getMutex(HttpSession session, String key, Object caller)
     {

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/UiDependencyTool.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/UiDependencyTool.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/UiDependencyTool.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/UiDependencyTool.java Mon Oct  1 17:27:15 2018
@@ -178,6 +178,8 @@ public class UiDependencyTool extends Sa
      * Adds all the files required for the specified group, then returns
      * this instance.  If the group name is null or no such group exists,
      * this will return null to indicate the error.
+     * @param name group name
+     * @return this or null
      */
     public UiDependencyTool on(String name) {
         Map<String,List<String>> groupDeps = getGroupDependencies(name);
@@ -193,6 +195,9 @@ public class UiDependencyTool extends Sa
      * Adds the specified file to this instance's list of dependencies
      * of the specified type, then returns this instance.  If either the
      * type or file are null, this will return null to indicate the error.
+     * @param type file type
+     * @param file dependency file
+     * @return this or null
      */
     public UiDependencyTool on(String type, String file) {
         if (type == null || file == null) {
@@ -206,6 +211,7 @@ public class UiDependencyTool extends Sa
     /**
      * Formats and prints all the current dependencies of this tool,
      * using a new line in between the printed/formatted files.
+     * @return all dependencies
      */
     public String print() {
         return printAll("\n");
@@ -219,6 +225,8 @@ public class UiDependencyTool extends Sa
      * as a delimiter and print all of this instance's dependencies of all
      * types, using the specified value as the delimiter in between the
      * printed/formatted files.
+     * @param typeOrDelim type asked for, or delimiter
+     * @return all dependencies
      * @see #print(String,String)
      * @see #printAll(String)
      */
@@ -236,6 +244,9 @@ public class UiDependencyTool extends Sa
      * Formats and prints all of this instance's current dependencies of the
      * specified type, using the specified delimiter in between the
      * printed/formatted files.
+     * @param type file type
+     * @param delim lines delimiter
+     * @return list of dependencies for thie type, formatted using delimiter
      */
     public String print(String type, String delim) {
         List<String> files = getDependencies(type);
@@ -255,6 +266,8 @@ public class UiDependencyTool extends Sa
     /**
      * Formats and prints all the current dependencies of this tool,
      * using the specified delimiter in between the printed/formatted files.
+     * @param delim delimiter
+     * @return list of dependencies
      */
     public String printAll(String delim) {
         if (dependencies == null) {
@@ -281,6 +294,8 @@ public class UiDependencyTool extends Sa
 
     /**
      * Sets a custom {context} variable for the formats to use.
+     * @param path context path
+     * @return this
      */
     public UiDependencyTool context(String path)
     {
@@ -290,6 +305,8 @@ public class UiDependencyTool extends Sa
 
     /**
      * Retrieves the configured format string for the specified file type.
+     * @param type file type
+     * @return configured format
      */
     public String getFormat(String type) {
         Type t = getType(type);
@@ -301,6 +318,8 @@ public class UiDependencyTool extends Sa
 
     /**
      * Sets the format string for the specified file type.
+     * @param type file type
+     * @param format format string
      */
     public void setFormat(String type, String format) {
         if (format == null || type == null) {
@@ -325,6 +344,7 @@ public class UiDependencyTool extends Sa
      * Returns the current dependencies of this instance, organized
      * as an ordered map of file types to lists of the required files
      * of that type.
+     * @return map of all dependencies
      */
     public Map<String,List<String>> getDependencies() {
         return dependencies;
@@ -332,6 +352,8 @@ public class UiDependencyTool extends Sa
 
     /**
      * Returns the {@link List} of files for the specified file type, if any.
+     * @param type file type
+     * @return all dependencies for this type
      */
     public List<String> getDependencies(String type) {
         if (dependencies == null) {
@@ -344,6 +366,8 @@ public class UiDependencyTool extends Sa
      * Returns the dependencies of the specified group, organized
      * as an ordered map of file types to lists of the required files
      * of that type.
+     * @param name group name
+     * @return map of all dependencies for this group
      */
     public Map<String,List<String>> getGroupDependencies(String name) {
         Group group = getGroup(name);
@@ -356,6 +380,7 @@ public class UiDependencyTool extends Sa
     /**
      * Returns an empty String to avoid polluting the template output after a
      * successful call to {@link #on(String)} or {@link #on(String,String)}.
+     * @return empty string
      */
     @Override
     public String toString() {
@@ -369,6 +394,8 @@ public class UiDependencyTool extends Sa
      * an IllegalArgumentException.  Otherwise, it will simply do nothing. Any
      * checked exceptions during the actual reading of the file are caught and
      * wrapped as {@link RuntimeException}s.
+     * @param file file
+     * @param required whether this file is required
      */
     protected void read(String file, boolean required) {
         getLog().debug("UiDependencyTool: Reading file from {}", file);
@@ -403,6 +430,7 @@ public class UiDependencyTool extends Sa
     /**
      * Creates the {@link Digester} used by {@link #read} to create
      * the group info for this instance out of the specified XML file.
+     * @return new digester
      */
     protected Digester createDigester() {
         Digester digester = new Digester();
@@ -420,6 +448,9 @@ public class UiDependencyTool extends Sa
      * Applies the format string to the given value.  Currently,
      * this simply replaces '{file}' with the value.  If you
      * want to handle more complicated formats, override this method.
+     * @param format format string
+     * @param value dependency file
+     * @return formatted string
      */
     protected String format(String format, String value) {
         if (format == null) {
@@ -431,6 +462,8 @@ public class UiDependencyTool extends Sa
     /**
      * NOTE: This method may change or disappear w/o warning; don't depend
      * on it unless you're willing to update your code whenever this changes.
+     * @param name file name
+     * @return group this file belongs to, or null
      */
     protected Group getGroup(String name) {
         if (groups == null) {
@@ -442,6 +475,8 @@ public class UiDependencyTool extends Sa
     /**
      * NOTE: This method may change or disappear w/o warning; don't depend
      * on it unless you're willing to update your code whenever this changes.
+     * @param name group name
+     * @return new group
      */
     protected Group makeGroup(String name) {
         getLog().trace("UiDependencyTool: Creating group '{}'", name);
@@ -453,6 +488,7 @@ public class UiDependencyTool extends Sa
     /**
      * Adds the specified files organized by type to this instance's
      * current dependencies.
+     * @param fbt dependencies map
      */
     protected void addDependencies(Map<String,List<String>> fbt) {
         if (this.dependencies == null) {
@@ -479,6 +515,8 @@ public class UiDependencyTool extends Sa
 
     /**
      * Adds a file to this instance's dependencies under the specified type.
+     * @param type file type
+     * @param file file name
      */
     protected void addFile(String type, String file) {
         List<String> files = null;
@@ -500,6 +538,8 @@ public class UiDependencyTool extends Sa
 
     /**
      * For internal use only. Use/override get/setFormat instead.
+     * @param type file type
+     * @return {@link Type} object
      */
     private Type getType(String type) {
         for (Type t : types) {

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityLayoutServlet.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityLayoutServlet.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityLayoutServlet.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityLayoutServlet.java Mon Oct  1 17:27:15 2018
@@ -182,6 +182,8 @@ public class VelocityLayoutServlet exten
     /**
      * Searches for a non-default layout to be used for this request.
      * This implementation checks the request parameters and attributes.
+     * @param request servlet request
+     * @return layout name or null
      */
     protected String findLayout(HttpServletRequest request)
     {
@@ -192,6 +194,9 @@ public class VelocityLayoutServlet exten
     /**
      * Overrides VelocityViewServlet.mergeTemplate to do a two-pass
      * render for handling layouts
+     * @param template {@link Template} object
+     * @param context Velocity context
+     * @param response servlet response
      */
     protected void mergeTemplate(Template template, Context context,
                                  HttpServletResponse response)
@@ -249,6 +254,9 @@ public class VelocityLayoutServlet exten
 
     /**
      * Overrides VelocityViewServlet to display user's custom error template
+     * @param request servlet request
+     * @param response servlet response
+     * @param e thrown error
      */
     protected void error(HttpServletRequest request,
                          HttpServletResponse response,

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityView.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityView.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityView.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityView.java Mon Oct  1 17:27:15 2018
@@ -202,7 +202,7 @@ public class VelocityView extends ViewTo
     }
 
     /**
-     * Returns the configured default Content-Type.
+     * @return the configured default Content-Type.
      */
     public String getDefaultContentType()
     {
@@ -211,6 +211,7 @@ public class VelocityView extends ViewTo
 
     /**
      * Sets the configured default Content-Type.
+     * @param type default content type
      */
     public void setDefaultContentType(String type)
     {
@@ -226,6 +227,9 @@ public class VelocityView extends ViewTo
      * because the VelocityEngine interface sucks compared to the singleton's.
      * Use of this method assumes that {@link #init(JeeConfig,VelocityEngine)}
      * has already been called.
+     * @param key property key
+     * @param alternate default value
+     * @return property value
      */
     protected String getProperty(String key, String alternate)
     {
@@ -286,6 +290,7 @@ public class VelocityView extends ViewTo
      * initialize the singleton in other ways.
      *
      * @param config servlet configuration parameters
+     * @param velocity VelocityEngine instance
      */
     protected void init(JeeConfig config, final VelocityEngine velocity)
     {
@@ -384,6 +389,8 @@ public class VelocityView extends ViewTo
      * tool, toolbox or data configurations if you set the
      * {@code org.apache.velocity.tools.cleanConfiguration} init-param to true in
      * either your servlet or servletContext init-params.
+     * @param config configuration values container
+     * @param factory toolbox factory instance
      */
     protected void configure(final JeeConfig config, final ToolboxFactory factory)
     {
@@ -657,6 +664,7 @@ public class VelocityView extends ViewTo
      * @param response HttpServletResponse object for the response
      * @return the {@link Context} prepared and used to perform the rendering
      *         to allow proper cleanup afterward
+     * @throws IOException if thrown by underling code
      */
     public Context render(HttpServletRequest request,
                           HttpServletResponse response) throws IOException
@@ -697,6 +705,7 @@ public class VelocityView extends ViewTo
      *
      * @param request servlet request from client
      * @param response servlet reponse to client
+     * @return newly created context
      */
     @Override
     public ViewToolContext createContext(HttpServletRequest request,
@@ -781,6 +790,7 @@ public class VelocityView extends ViewTo
      * @param template template being rendered
      * @param context Context created by the {@link #createContext}
      * @param writer into which the content is rendered
+     * @throws IOException if thrown by underling code
      */
     public void merge(Template template, Context context, Writer writer)
         throws IOException
@@ -832,6 +842,7 @@ public class VelocityView extends ViewTo
      * @param template template object returned by the handleRequest() method
      * @param context Context created by the {@link #createContext}
      * @param writer a VelocityWriter that the template is merged into
+     * @throws IOException if thrown by underling code
      */
     protected void performMerge(Template template, Context context, Writer writer)
         throws IOException

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityViewFilter.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityViewFilter.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityViewFilter.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityViewFilter.java Mon Oct  1 17:27:15 2018
@@ -67,7 +67,7 @@ import org.apache.velocity.tools.view.Vi
  *   <dd>By default, this is {@code true}. If set to {@code false}, then
  *     the {@link VelocityView} used by this filter will not be shared
  *     with other VelocityViewFilters, {@link VelocityViewServlet}s or
- *     {@link org.apache.velocity.tools.view.jsp.VelocityViewTag}s in the
+ *     org.apache.velocity.tools.view.jsp.VelocityViewTag's in the
  *     application.</dd>
  *   <dt>org.apache.velocity.tools.context.key</dt>
  *   <dd>If you set a value for this property, this filter will create
@@ -132,6 +132,8 @@ public class VelocityViewFilter implemen
     /**
      * Looks up an init parameter with the specified key in either the
      * FilterConfig or, failing that, in the ServletContext.
+     * @param key init parameter key
+     * @return found value or null
      */
     protected String findInitParameter(String key)
     {

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityViewServlet.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityViewServlet.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityViewServlet.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/VelocityViewServlet.java Mon Oct  1 17:27:15 2018
@@ -73,7 +73,7 @@ import org.apache.commons.lang3.StringEs
  *   <dd>By default, this is {@code true}. If set to {@code false}, then
  *     the {@link VelocityView} used by this servlet will not be shared
  *     with {@link VelocityViewFilter}s, other VelocityViewServlets or
- *     {@link org.apache.velocity.tools.view.jsp.VelocityViewTag}s in the
+ *     org.apache.velocity.tools.view.jsp.VelocityViewTag's in the
  *     application.</dd>
  *   <dt>org.apache.velocity.tools.loadDefaults</dt>
  *   <dd>By default, this is {@code true}. If set to {@code false}, then
@@ -137,6 +137,9 @@ public class VelocityViewServlet extends
     /**
      * Looks up an init parameter with the specified key in either the
      * ServletConfig or, failing that, in the ServletContext.
+     * @param config servlet config
+     * @param key parameter key
+     * @return parameter value or null
      */
     protected String findInitParameter(ServletConfig config, String key)
     {
@@ -179,6 +182,10 @@ public class VelocityViewServlet extends
 
     /**
      * Handles GET - calls doRequest()
+     * @param request servlet request
+     * @param response servlet response
+     * @throws ServletException from underlying call
+     * @throws IOException from underlying call
      */
     public void doGet(HttpServletRequest request, HttpServletResponse response)
         throws ServletException, IOException
@@ -189,6 +196,10 @@ public class VelocityViewServlet extends
 
     /**
      * Handle a POST request - calls doRequest()
+     * @param request servlet request
+     * @param response servlet response
+     * @throws ServletException from underlying call
+     * @throws IOException from underlying call
      */
     public void doPost(HttpServletRequest request, HttpServletResponse response)
         throws ServletException, IOException
@@ -202,6 +213,7 @@ public class VelocityViewServlet extends
      *
      *  @param request  HttpServletRequest object containing client request
      *  @param response HttpServletResponse object for the response
+     *  @throws IOException from underlying processing
      */
     protected void doRequest(HttpServletRequest request, HttpServletResponse response)
         throws IOException
@@ -251,8 +263,9 @@ public class VelocityViewServlet extends
      *    Velocity input encoding.
      *  </p>
      *
-     *  @param request  HttpServletRequest object containing client request
-     *  @param response HttpServletResponse object for the response
+     * @param request  HttpServletRequest object containing client request
+     * @param response HttpServletResponse object for the response
+     * @throws IOException if thrown by underlying handling
      */
     protected void initRequest(HttpServletRequest request, HttpServletResponse response) throws IOException
     {

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewContext.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewContext.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewContext.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewContext.java Mon Oct  1 17:27:15 2018
@@ -59,19 +59,19 @@ public interface ViewContext
 
 
     /**
-     * <p>Returns the instance of {@link HttpServletRequest} for this request.</p>
+     * @return the instance of {@link HttpServletRequest} for this request.
      */
     public HttpServletRequest getRequest();
 
 
     /**
-     * <p>Returns the instance of {@link HttpServletResponse} for this request.</p>
+     * @return the instance of {@link HttpServletResponse} for this request.
      */
     public HttpServletResponse getResponse();
 
 
     /**
-     * <p>Returns the instance of {@link ServletContext} for this request.</p>
+     * @return the instance of {@link ServletContext} for this request.
      */
     public ServletContext getServletContext();
 
@@ -80,20 +80,21 @@ public interface ViewContext
      * <p>Searches for the named attribute in request, session (if valid),
      * and application scope(s) in order and returns the value associated
      * or null.</p>
-     *
+     * @param key attribute key
+     * @return attribute value or null
      * @since VelocityTools 1.1
      */
     public Object getAttribute(String key);
 
 
     /**
-     * <p>Returns a reference to the current Velocity context.</p>
+     * @return a reference to the current Velocity context.
      */
     public Context getVelocityContext();
 
 
     /**
-     * <p>Returns the current VelocityEngine instance.</p>
+     * @return the current VelocityEngine instance.
      */
     public VelocityEngine getVelocityEngine();
 

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewImportSupport.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewImportSupport.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewImportSupport.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewImportSupport.java Mon Oct  1 17:27:15 2018
@@ -87,6 +87,7 @@ public class ViewImportSupport extends I
      * Sets the current {@link HttpServletRequest}. This is required
      * for this tool to operate and will throw a NullPointerException
      * if this is not set or is set to {@code null}.
+     * @param request servlet request
      */
     public void setRequest(HttpServletRequest request)
     {
@@ -101,6 +102,7 @@ public class ViewImportSupport extends I
      * Sets the current {@link HttpServletResponse}. This is required
      * for this tool to operate and will throw a NullPointerException
      * if this is not set or is set to {@code null}.
+     * @param response servlet response
      */
     public void setResponse(HttpServletResponse response)
     {
@@ -115,6 +117,7 @@ public class ViewImportSupport extends I
      * Sets the {@link ServletContext}. This is required
      * for this tool to operate and will throw a NullPointerException
      * if this is not set or is set to {@code null}.
+     * @param application servlet context
      */
     public void setServletContext(ServletContext application)
     {
@@ -148,7 +151,7 @@ public class ViewImportSupport extends I
      *
      * @param url the remote URL resource to return as string
      * @return the URL resource as string
-     * @throws IOException
+     * @throws IOException if thrown by underlying code
      */
     protected String acquireRemoteURLString(String url) throws IOException
     {
@@ -164,7 +167,7 @@ public class ViewImportSupport extends I
      *
      * @param url the local URL resource to return as string
      * @return the URL resource as string
-     * @throws IOException
+     * @throws IOException if not allowed or if thrown by underlying code
      */
     protected String acquireLocalURLString(String url) throws IOException
     {
@@ -239,7 +242,7 @@ public class ViewImportSupport extends I
      *
      * @param url the URL to read
      * @return a Reader for the InputStream created from the supplied URL
-     * @throws IOException
+     * @throws IOException if not allowed or thrown by underlying code
      */
     protected Reader acquireRemoteURLReader(String url) throws IOException
     {
@@ -255,7 +258,7 @@ public class ViewImportSupport extends I
      *
      * @param url the URL to read
      * @return a Reader for the InputStream created from the supplied URL
-     * @throws IOException
+     * @throws IOException if thrown by underlying code
      */
     protected Reader acquireLocalURLReader(String url) throws IOException
     {
@@ -431,13 +434,17 @@ public class ViewImportSupport extends I
             return sos;
         }
 
-        /** Has no effect. */
+        /** Has no effect.
+         * @param x ignored
+         */
         public void setContentType(String x)
         {
             // ignore
         }
 
-        /** Has no effect. */
+        /** Has no effect.
+         * @param x ignored
+         */
         public void setLocale(Locale x)
         {
             // ignore

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewToolContext.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewToolContext.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewToolContext.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewToolContext.java Mon Oct  1 17:27:15 2018
@@ -179,6 +179,8 @@ public class ViewToolContext extends Too
     /**
      * Finds "user" set values, either in the local context
      * or in the scoped attributes if none is in the local context.
+     * @param key attribute name
+     * @return found value or null
      * @see #internalGet
      * @see #getAttribute
      */
@@ -195,6 +197,8 @@ public class ViewToolContext extends Too
     /**
      * Finds the automatically provided values, either configured
      * tools or servlet API objects (request, response, etc).
+     * @param key attribute key
+     * @return found configured value or null
      * @see #findTool
      * @see #getServletApi
      */
@@ -212,6 +216,8 @@ public class ViewToolContext extends Too
      * Returns the current matching servlet request, response, session,
      * or servlet context instance, or null if the key matches none of those
      * keys.
+     * @param key attribute key
+     * @return found value or null
      */
     protected Object getServletApi(String key)
     {
@@ -239,7 +245,8 @@ public class ViewToolContext extends Too
      * <p>Searches for the named attribute in request, session (if valid),
      * and application scope(s) in order and returns the value associated
      * or null.</p>
-     *
+     * @param key attribute key
+     * @return found value or null
      * @since VelocityTools 1.1
      */
     public Object getAttribute(String key)
@@ -274,7 +281,7 @@ public class ViewToolContext extends Too
 
 
     /**
-     * <p>Returns the current servlet request.</p>
+     * @return the current servlet request.
      */
     public HttpServletRequest getRequest()
     {
@@ -282,7 +289,7 @@ public class ViewToolContext extends Too
     }
 
     /**
-     * <p>Returns the current servlet response.</p>
+     * @return the current servlet response.
      */
     public HttpServletResponse getResponse()
     {
@@ -290,7 +297,7 @@ public class ViewToolContext extends Too
     }
 
     /**
-     * <p>Returns the current session, if any.</p>
+     * @return the current session, if any.
      */
     public HttpSession getSession()
     {
@@ -298,7 +305,7 @@ public class ViewToolContext extends Too
     }
 
     /**
-     * <p>Returns the servlet context.</p>
+     * @return the servlet context.
      */
     public ServletContext getServletContext()
     {
@@ -306,7 +313,7 @@ public class ViewToolContext extends Too
     }
 
     /**
-     * <p>Returns a reference to the Velocity context (this object).</p>
+     * @return a reference to the Velocity context (this object).
      */
     public Context getVelocityContext()
     {
@@ -314,7 +321,7 @@ public class ViewToolContext extends Too
     }
 
     /**
-     * <p>Returns a reference to the VelocityEngine.</p>
+     * @return a reference to the VelocityEngine.
      */
     public VelocityEngine getVelocityEngine()
     {

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewToolManager.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewToolManager.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewToolManager.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/ViewToolManager.java Mon Oct  1 17:27:15 2018
@@ -64,6 +64,7 @@ public class ViewToolManager extends Too
      * Constructs an instance already configured to use
      * any configuration specified via a "org.apache.velocity.tools"
      * system property.
+     * @param app servlet context
      */
     public ViewToolManager(ServletContext app)
     {
@@ -112,6 +113,7 @@ public class ViewToolManager extends Too
      * context. <b>It is important to note that if this is set to false,
      * session-scoped tools will NOT be stored in the session, but instead
      * be recreated for each request.</b>
+     * @param publish whether to publish the available toolboxes     
      * @see #publishToolboxes
      * @see #setToolboxKey
      */
@@ -131,6 +133,7 @@ public class ViewToolManager extends Too
 
     /**
      * Sets a new attribute key to be used for publishing each {@link Toolbox}.
+     * @param key toolbox key
      * @see #setPublishToolboxes
      * @see #publishToolboxes
      */
@@ -157,6 +160,7 @@ public class ViewToolManager extends Too
      * Sets whether or not a new HttpSession should be created
      * when there are session scoped tools to be stored in the session,
      * but no session has been created yet.
+     * @param create whether to create a new session if needed
      * @see #publishToolboxes
      */
     public void setCreateSession(boolean create)
@@ -301,6 +305,7 @@ public class ViewToolManager extends Too
      * Places the {@link Scope#REQUEST} {@link Toolbox} (if any)
      * into the {@link ServletRequest} attributes using
      * {@link Toolbox#KEY} as the key.
+     * @param request servlet request
      */
     public void publishToolboxes(ServletRequest request)
     {
@@ -323,6 +328,7 @@ public class ViewToolManager extends Too
      * Toolbox (if any) into the attributes of the {@link HttpSession} (if any)
      * then ensures that the {@link Scope#APPLICATION} Toolbox (if any)
      * has been placed in the {@link ServletContext} attributes.
+     * @param request servlet request
      */
     public void publishToolboxes(HttpServletRequest request)
     {

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/WebappUberspector.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/WebappUberspector.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/WebappUberspector.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/WebappUberspector.java Mon Oct  1 17:27:15 2018
@@ -57,9 +57,9 @@ public class WebappUberspector extends A
 
     /**
      * Property getter
-     * @param obj
-     * @param identifier
-     * @param i
+     * @param obj target object
+     * @param identifier property key
+     * @param i tool info
      * @return A Velocity Getter Method.
      */
     public VelPropertyGet getPropertyGet(Object obj, String identifier, Info i)
@@ -98,10 +98,10 @@ public class WebappUberspector extends A
 
     /**
      * Property setter
-     * @param obj
-     * @param identifier
-     * @param arg
-     * @param i
+     * @param obj target object
+     * @param identifier property key
+     * @param arg value to set
+     * @param i tool info
      * @return A Velocity Setter method.
      */
     public VelPropertySet getPropertySet(Object obj, String identifier,
@@ -138,10 +138,10 @@ public class WebappUberspector extends A
         private Object [] params;
 
         /**
-         * @param log
-         * @param introspector
-         * @param clazz
-         * @param property
+         * @param log logger
+         * @param introspector introspector instance
+         * @param clazz class name
+         * @param property property name
          */
         public GetAttributeExecutor(final Logger log, final Introspector introspector,
                 final Class clazz, final String property)
@@ -173,6 +173,10 @@ public class WebappUberspector extends A
         }
 
         /**
+         * @param o target object
+         * @return execution result
+         * @throws IllegalAccessException if thrown by underlying code
+         * @throws InvocationTargetException if thrown by underlying code
          * @see org.apache.velocity.runtime.parser.node.AbstractExecutor#execute(java.lang.Object)
          */
         public Object execute(final Object o)
@@ -191,11 +195,11 @@ public class WebappUberspector extends A
         private final String property;
 
         /**
-         * @param log
-         * @param introspector
-         * @param clazz
-         * @param arg
-         * @param property
+         * @param log logger
+         * @param introspector introspector instance
+         * @param clazz target class
+         * @param arg value to set
+         * @param property property name
          */
         public SetAttributeExecutor(final Logger log, final Introspector introspector,
                 final Class clazz, final Object arg, final String property)
@@ -208,8 +212,8 @@ public class WebappUberspector extends A
         }
 
         /**
-         * @param clazz
-         * @param arg
+         * @param clazz target class
+         * @param arg expected arguments
          */
         protected void discover(final Class clazz, final Object arg)
         {
@@ -233,6 +237,10 @@ public class WebappUberspector extends A
         }
 
         /**
+         * @param o target object
+         * @param value value to set
+         * @throws IllegalAccessException if thrown by underlying code
+         * @throws InvocationTargetException if thrown by underlying code
          * @see org.apache.velocity.runtime.parser.node.SetExecutor#execute(java.lang.Object, java.lang.Object)
          */
         public Object execute(final Object o, final Object value)

Modified: velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/XmlTool.java
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/XmlTool.java?rev=1842523&r1=1842522&r2=1842523&view=diff
==============================================================================
--- velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/XmlTool.java (original)
+++ velocity/tools/trunk/velocity-tools-view/src/main/java/org/apache/velocity/tools/view/XmlTool.java Mon Oct  1 17:27:15 2018
@@ -39,7 +39,7 @@ public class XmlTool extends org.apache.
 
     /**
      * ImportSupport initialization.
-     * @param config
+     * @param config configuration values
      */
     @Override
     protected synchronized void initializeImportSupport(ValueParser config)
@@ -53,7 +53,7 @@ public class XmlTool extends org.apache.
 
     /**
      * Configuration. Parses request body if appropriate.
-     * @param values
+     * @param values configuration values
      */
     protected void configure(ValueParser values)
     {



Mime
View raw message