I noticed a lot of javadoc warnings when building the tools, so I grabbed the CVS source, fixed them, then diff'ed it. The diff is attached. All of the changes are minor, no actual code is changed anywhere, only javadoc comments and a couple package.html files.
Nathan
Index: src/java/org/apache/velocity/tools/generic/DateTool.java
===================================================================
RCS file:
/home/cvspublic/jakarta-velocity-tools/src/java/org/apache/velocity/tools/generic/DateTool.java,v
retrieving revision 1.11
diff -u -r1.11 DateTool.java
--- src/java/org/apache/velocity/tools/generic/DateTool.java 18 Feb 2004 20:11:07
-0000 1.11
+++ src/java/org/apache/velocity/tools/generic/DateTool.java 10 Mar 2004 23:44:19
-0000
@@ -538,8 +538,9 @@
/**
* Checks a string to see if it matches one of the standard DateFormat
- * style patterns: FULL, LONG, MEDIUM, SHORT, or DEFAULT. if it does it will
return
- * the integer constant for that pattern. if not, it will return -1.
+ * style patterns: FULL, LONG, MEDIUM, SHORT, or DEFAULT. If it does,
+ * it will return the integer constant for that pattern. If not, it
+ * will return -1.
*
* @see DateFormat
* @param style the string to be checked
Index: src/java/org/apache/velocity/tools/generic/MathTool.java
===================================================================
RCS file:
/home/cvspublic/jakarta-velocity-tools/src/java/org/apache/velocity/tools/generic/MathTool.java,v
retrieving revision 1.6
diff -u -r1.6 MathTool.java
--- src/java/org/apache/velocity/tools/generic/MathTool.java 18 Feb 2004 20:11:07
-0000 1.6
+++ src/java/org/apache/velocity/tools/generic/MathTool.java 10 Mar 2004 23:44:19
-0000
@@ -186,7 +186,7 @@
/**
- * @param num1 the number
+ * @param num the number
* @return the absolute value of the number or
* <code>null</code> if it's invalid
* @see #toDouble
@@ -240,7 +240,7 @@
* @param num the number to round
* @return the number rounded to the nearest whole Integer
* or <code>null</code> if it's invalid
- * @see java.lang.Math.rint(double)
+ * @see java.lang.Math#rint(double)
*/
public Integer round(Object num)
{
@@ -261,7 +261,7 @@
* an [EMAIL PROTECTED] Integer} rather than a [EMAIL PROTECTED] Double}.
*
* @param decimals the number of decimal places
- * @param value the number to round
+ * @param num the number to round
* @return the value rounded to the specified number of
* decimal places or <code>null</code> if it's invalid
* @see #toNumber
cvs server: cannot find src/java/org/apache/velocity/tools/struts/ErrorsTool.java
Index: src/java/org/apache/velocity/tools/struts/SecureLinkTool.java
===================================================================
RCS file:
/home/cvspublic/jakarta-velocity-tools/src/java/org/apache/velocity/tools/struts/SecureLinkTool.java,v
retrieving revision 1.9
diff -u -r1.9 SecureLinkTool.java
--- src/java/org/apache/velocity/tools/struts/SecureLinkTool.java 18 Feb 2004
20:09:51 -0000 1.9
+++ src/java/org/apache/velocity/tools/struts/SecureLinkTool.java 10 Mar 2004
23:44:20 -0000
@@ -29,8 +29,9 @@
import org.apache.struts.Globals;
/**
- * <p>Tool to be able to use Struts SSL Extensions with Velocity</p>
- * <p>It has the same interface as StrutsLinkTool and can function as a substitute if
Struts 1.1 and SSL Ext are installed. </p>
+ * Tool to be able to use Struts SSL Extensions with Velocity.
+ * <p>It has the same interface as StrutsLinkTool and can function as a
+ * substitute if Struts 1.1 and SSL Ext are installed. </p>
* <p>Usage:
* <pre>
* Template example:
Index: src/java/org/apache/velocity/tools/struts/StrutsUtils.java
===================================================================
RCS file:
/home/cvspublic/jakarta-velocity-tools/src/java/org/apache/velocity/tools/struts/StrutsUtils.java,v
retrieving revision 1.15
diff -u -r1.15 StrutsUtils.java
--- src/java/org/apache/velocity/tools/struts/StrutsUtils.java 18 Feb 2004 20:09:51
-0000 1.15
+++ src/java/org/apache/velocity/tools/struts/StrutsUtils.java 10 Mar 2004 23:44:20
-0000
@@ -77,7 +77,7 @@
* Returns the default configured data source (which must implement
* <code>javax.sql.DataSource</code>) or <code>null</code> if not found.
*
- * @param application the servlet context
+ * @param app the servlet context
* @deprecated This will be removed in VelocityTools 1.2
*/
public static DataSource getDataSource(ServletContext app)
@@ -90,7 +90,7 @@
* Returns the <code>org.apache.struts.action.ActionFormBeans</code>
* collection for this application or <code>null</code> if not found.
*
- * @param application the servlet context
+ * @param app the servlet context
* @deprecated This will be removed in VelocityTools 1.2
*/
public static ActionFormBeans getActionFormBeans(ServletContext app)
@@ -104,7 +104,7 @@
* logical name or <code>null</code> if not found.
*
* @param name logical name of the requested form bean definition
- * @param application the servlet context
+ * @param app the servlet context
* @deprecated This will be removed in VelocityTools 1.2
*/
public static FormBeanConfig getFormBean(String name, ServletContext app)
@@ -123,7 +123,7 @@
* Returns the <code>org.apache.struts.action.ActionForwards</code>
* collection for this application or <code>null</code> if not found.
*
- * @param application the servlet context
+ * @param app the servlet context
* @deprecated This will be removed in VelocityTools 1.2
*/
public static ActionForwards getActionForwards(ServletContext app)
@@ -137,7 +137,7 @@
* or <code>null</code> if not found.
*
* @param name Logical name of the requested forwarding
- * @param appplication the servlet context
+ * @param app the servlet context
* @deprecated This will be removed in VelocityTools 1.2
*/
public static ActionForward getActionForward(String name,
@@ -156,7 +156,7 @@
* Returns the <code>org.apache.struts.action.ActionMappings</code>
* collection for this application or <code>null</code> if not found.
*
- * @param application the servlet context
+ * @param app the servlet context
* @deprecated This will be removed in VelocityTools 1.2
*/
public static ActionMappings getActionMappings(ServletContext app)
@@ -170,7 +170,7 @@
* or <code>null</code> if not found.
*
* @param path Request path for which a mapping is requested
- * @param application the servlet context
+ * @param app the servlet context
* @deprecated This will be removed in VelocityTools 1.2
*/
public static ActionMapping getActionMapping(String path,
@@ -189,7 +189,7 @@
* Returns the message resources for this application or <code>null</code>
* if not found.
*
- * @param application the servlet context
+ * @param app the servlet context
* @deprecated This will be removed in VelocityTools 1.2
*/
public static MessageResources getMessageResources(ServletContext app)
@@ -202,7 +202,7 @@
* Returns the message resources for this application or <code>null</code>
* if not found.
*
- * @param application the servlet context
+ * @param app the servlet context
* @since VelocityTools 1.1
*/
public static MessageResources getMessageResources(HttpServletRequest request,
@@ -219,7 +219,7 @@
* Returns the message resources with the specified bundle name for this
application
* or <code>null</code> if not found.
*
- * @param application the servlet context
+ * @param app the servlet context
* @param bundle The bundle name to look for. If this is <code>null</code>, the
* default bundle name is used.
* @since VelocityTools 1.1
@@ -278,7 +278,7 @@
* either a path-mapped pattern (<code>/action/*</code>) or an
* extension mapped pattern (<code>*.do</code>).
*
- * @param application the servlet context
+ * @param app the servlet context
* @deprecated This will be removed in VelocityTools 1.2
*/
public static String getServletMapping(ServletContext app)
@@ -555,7 +555,7 @@
* Returns the action forward name converted into a server-relative URI
* reference.
*
- * @param application the servlet context
+ * @param app the servlet context
* @param request the servlet request
* @param forward the name of a forward as per struts-config.xml
*/
Index: src/java/org/apache/velocity/tools/struts/TilesTool.java
===================================================================
RCS file:
/home/cvspublic/jakarta-velocity-tools/src/java/org/apache/velocity/tools/struts/TilesTool.java,v
retrieving revision 1.11
diff -u -r1.11 TilesTool.java
--- src/java/org/apache/velocity/tools/struts/TilesTool.java 18 Feb 2004 20:09:51
-0000 1.11
+++ src/java/org/apache/velocity/tools/struts/TilesTool.java 10 Mar 2004 23:44:20
-0000
@@ -40,7 +40,7 @@
import org.apache.velocity.tools.view.tools.ViewTool;
/**
- * <p>View tool to use struts-tiles with Velocity</p>
+ * View tool to use struts-tiles with Velocity.
* <p><pre>
* Template example(s):
* <!-- insert a tile -->
@@ -111,12 +111,12 @@
/***************************** View Helpers ******************************/
/**
- * <p>A generic tiles insert function</p>
+ * A generic tiles insert function.
*
* <p>This is functionally equivalent to
* <code><tiles:insert attribute="foo" /></code>.</p>
*
- * @param attr - can be any of the following:
+ * @param obj Can be any of the following:
* AttributeDefinition,
* tile-definition name,
* tile-attribute name,
@@ -505,8 +505,8 @@
}
/**
- * <p>pops the tiles sub-context off the context-stack after the lower level
- * tiles have been rendered</p>
+ * Pops the tiles sub-context off the context-stack after the lower level
+ * tiles have been rendered.
*/
protected void popTilesContext()
{
Index: src/java/org/apache/velocity/tools/struts/package.html
===================================================================
RCS file:
/home/cvspublic/jakarta-velocity-tools/src/java/org/apache/velocity/tools/struts/package.html,v
retrieving revision 1.2
diff -u -r1.2 package.html
--- src/java/org/apache/velocity/tools/struts/package.html 22 Mar 2003 20:33:09
-0000 1.2
+++ src/java/org/apache/velocity/tools/struts/package.html 10 Mar 2004 23:44:20
-0000
@@ -10,8 +10,8 @@
<body bgcolor="white">
-Provides view tools to integrate Velocity with the Jakarta
-Struts framework.
+<p>Provides view tools to integrate Velocity with the Jakarta
+Struts framework.</p>
<!--
##### THIS IS THE TEMPLATE FOR THE PACKAGE DOC COMMENTS. #####
Index: src/java/org/apache/velocity/tools/view/ViewToolInfo.java
===================================================================
RCS file:
/home/cvspublic/jakarta-velocity-tools/src/java/org/apache/velocity/tools/view/ViewToolInfo.java,v
retrieving revision 1.7
diff -u -r1.7 ViewToolInfo.java
--- src/java/org/apache/velocity/tools/view/ViewToolInfo.java 18 Feb 2004 20:08:29
-0000 1.7
+++ src/java/org/apache/velocity/tools/view/ViewToolInfo.java 10 Mar 2004 23:44:20
-0000
@@ -47,7 +47,7 @@
* class loader is set for the current thread, then the class loader
* that loaded this class will be used.
*
- * @param className Fully qualified class name to be loaded
+ * @param name Fully qualified class name to be loaded
* @return Class object
* @exception ClassNotFoundException if the class cannot be found
* @since VelocityTools 1.1
Index: src/java/org/apache/velocity/tools/view/context/package.html
===================================================================
RCS file:
/home/cvspublic/jakarta-velocity-tools/src/java/org/apache/velocity/tools/view/context/package.html,v
retrieving revision 1.1
diff -u -r1.1 package.html
--- src/java/org/apache/velocity/tools/view/context/package.html 5 Mar 2003
06:13:03 -0000 1.1
+++ src/java/org/apache/velocity/tools/view/context/package.html 10 Mar 2004
23:44:21 -0000
@@ -9,8 +9,8 @@
</head>
<body bgcolor="white">
-Provides special purpose implementations of the VelocityContext class
-related to the automatic toolbox management in a servlet environment.
+<p>Provides special purpose implementations of the VelocityContext class
+related to the automatic toolbox management in a servlet environment.</p>
<!--
##### THIS IS THE TEMPLATE FOR THE PACKAGE DOC COMMENTS. #####
Index: src/java/org/apache/velocity/tools/view/i18n/MultiViewsTool.java
===================================================================
RCS file:
/home/cvspublic/jakarta-velocity-tools/src/java/org/apache/velocity/tools/view/i18n/MultiViewsTool.java,v
retrieving revision 1.3
diff -u -r1.3 MultiViewsTool.java
--- src/java/org/apache/velocity/tools/view/i18n/MultiViewsTool.java 18 Feb 2004
20:07:32 -0000 1.3
+++ src/java/org/apache/velocity/tools/view/i18n/MultiViewsTool.java 10 Mar 2004
23:44:21 -0000
@@ -27,9 +27,9 @@
import org.apache.velocity.tools.view.tools.ViewTool;
/**
- * <p>Allows for transparent content negotiation in a manner mimicking
+ * Allows for transparent content negotiation in a manner mimicking
* Apache httpd's <a
- *
href="http://httpd.apache.org/docs-2.0/content-negotiation.html";>MultiViews</a></p>.
+ * href="http://httpd.apache.org/docs-2.0/content-negotiation.html";>MultiViews</a>.
*
* <p>Reads the default language out of the ViewContext as
* <code>org.apache.velocity.tools.view.i18n.defaultLanguage</code>.
Index: src/java/org/apache/velocity/tools/view/servlet/VelocityViewServlet.java
===================================================================
RCS file:
/home/cvspublic/jakarta-velocity-tools/src/java/org/apache/velocity/tools/view/servlet/VelocityViewServlet.java,v
retrieving revision 1.20
diff -u -r1.20 VelocityViewServlet.java
--- src/java/org/apache/velocity/tools/view/servlet/VelocityViewServlet.java 18 Feb
2004 20:07:02 -0000 1.20
+++ src/java/org/apache/velocity/tools/view/servlet/VelocityViewServlet.java 10 Mar
2004 23:44:21 -0000
@@ -625,7 +625,7 @@
*
* @param request original HttpServletRequest from servlet container.
* @param response HttpServletResponse object from servlet container.
- * @param cause Exception that was thrown by some other part of process.
+ * @param e Exception that was thrown by some other part of process.
*/
protected void error(HttpServletRequest request,
HttpServletResponse response,
Index: src/java/org/apache/velocity/tools/view/tools/AbstractSearchTool.java
===================================================================
RCS file:
/home/cvspublic/jakarta-velocity-tools/src/java/org/apache/velocity/tools/view/tools/AbstractSearchTool.java,v
retrieving revision 1.6
diff -u -r1.6 AbstractSearchTool.java
--- src/java/org/apache/velocity/tools/view/tools/AbstractSearchTool.java 18 Feb
2004 20:06:11 -0000 1.6
+++ src/java/org/apache/velocity/tools/view/tools/AbstractSearchTool.java 10 Mar
2004 23:44:22 -0000
@@ -227,7 +227,7 @@
/**
* Sets the index of the first result in the current page
*
- * @param index - the result index to start the current page with
+ * @param index the result index to start the current page with
*/
public void setIndex(int index)
{
@@ -243,7 +243,7 @@
/**
* Sets the number of items returned in a page of results
*
- * @param itemsPerPage - the number of items to be returned per page
+ * @param itemsPerPage the number of items to be returned per page
*/
public void setItemsPerPage(int itemsPerPage)
{
@@ -423,7 +423,7 @@
* Returns the "page number" for the specified index. Because the page
* number is used for the user interface, the page numbers are 1-based.
*
- * @param i the index that you want the page number for
+ * @param i the index that you want the page number for
* @return the approximate "page number" for the specified index or
* <code>null</code> if there are no results
*/
@@ -623,7 +623,7 @@
* HttpSession or to prevent storage of results across requests. In
* the former situation, you must also override getStoredResults().</p>
*
- * @param results the [EMAIL PROTECTED] StoredResults} to be stored
+ * @param results the [EMAIL PROTECTED] StoredResults} to be stored
*/
protected void setStoredResults(StoredResults results)
{
@@ -656,8 +656,8 @@
/**
* Creates a new instance.
*
- * @param criteria - the criteria for these results
- * @param list - the [EMAIL PROTECTED] List} of results to store
+ * @param crit the criteria for these results
+ * @param list the [EMAIL PROTECTED] List} of results to store
*/
public StoredResults(Object crit, List list)
{
Index: src/java/org/apache/velocity/tools/view/tools/ImportTool.java
===================================================================
RCS file:
/home/cvspublic/jakarta-velocity-tools/src/java/org/apache/velocity/tools/view/tools/ImportTool.java,v
retrieving revision 1.4
diff -u -r1.4 ImportTool.java
--- src/java/org/apache/velocity/tools/view/tools/ImportTool.java 18 Feb 2004
20:06:11 -0000 1.4
+++ src/java/org/apache/velocity/tools/view/tools/ImportTool.java 10 Mar 2004
23:44:22 -0000
@@ -27,8 +27,8 @@
import org.apache.velocity.tools.view.tools.ViewTool;
/**
- * <p>General-purpose text-importing view tool for templates</p>
- * <p>Usage:<br>
+ * General-purpose text-importing view tool for templates.
+ * <p>Usage:<br />
* Just call $import.read("http://www.foo.com/bleh.jsp?sneh=bar";) to insert the
contents of the named
* resource into the template.
* </p>
Index: src/java/org/apache/velocity/tools/view/tools/LinkTool.java
===================================================================
RCS file:
/home/cvspublic/jakarta-velocity-tools/src/java/org/apache/velocity/tools/view/tools/LinkTool.java,v
retrieving revision 1.14
diff -u -r1.14 LinkTool.java
--- src/java/org/apache/velocity/tools/view/tools/LinkTool.java 18 Feb 2004 20:06:11
-0000 1.14
+++ src/java/org/apache/velocity/tools/view/tools/LinkTool.java 10 Mar 2004 23:44:22
-0000
@@ -32,7 +32,7 @@
import org.apache.velocity.tools.view.tools.ViewTool;
/**
- * <p>View tool to make building URIs pleasant and fun! :)</p>
+ * View tool to make building URIs pleasant and fun!
* <p><pre>
* Template example(s):
* #set( $base = $link.setRelative('MyPage.vm').setAnchor('view') )
@@ -188,7 +188,7 @@
* Copies 'that' LinkTool into this one and sets the new
* anchor for the link.
*
- * @param uri uri string
+ * @param anchor URI string
*/
protected LinkTool copyWithAnchor(String anchor)
{
Index: src/java/org/apache/velocity/tools/view/tools/ParameterParser.java
===================================================================
RCS file:
/home/cvspublic/jakarta-velocity-tools/src/java/org/apache/velocity/tools/view/tools/ParameterParser.java,v
retrieving revision 1.8
diff -u -r1.8 ParameterParser.java
--- src/java/org/apache/velocity/tools/view/tools/ParameterParser.java 18 Feb 2004
20:06:11 -0000 1.8
+++ src/java/org/apache/velocity/tools/view/tools/ParameterParser.java 10 Mar 2004
23:44:22 -0000
@@ -61,7 +61,7 @@
/**
* Constructs a new instance using the specified request.
*
- * @param the [EMAIL PROTECTED] ServletRequest} to be parsed
+ * @param request the [EMAIL PROTECTED] ServletRequest} to be parsed
*/
public ParameterParser(ServletRequest request)
{
@@ -97,7 +97,7 @@
/**
* Sets the current [EMAIL PROTECTED] ServletRequest}
*
- * @param the [EMAIL PROTECTED] ServletRequest} to be parsed
+ * @param request the [EMAIL PROTECTED] ServletRequest} to be parsed
*/
protected void setRequest(ServletRequest request)
{
@@ -166,8 +166,8 @@
/**
- * @param the desired parameter's key
- * @param the alternate value
+ * @param key the desired parameter's key
+ * @param alternate The alternate value
* @return parameter matching the specified key or the
* specified alternate String if there is no matching
* parameter
@@ -180,7 +180,7 @@
/**
- * @param the desired parameter's key
+ * @param key the desired parameter's key
* @return a [EMAIL PROTECTED] Boolean} object for the specified key or
* <code>null</code> if no matching parameter is found
*/
@@ -192,8 +192,8 @@
/**
- * @param the desired parameter's key
- * @param the alternate boolean value
+ * @param key the desired parameter's key
+ * @param alternate The alternate boolean value
* @return boolean value for the specified key or the
* alternate boolean is no value is found
*/
@@ -205,8 +205,8 @@
/**
- * @param the desired parameter's key
- * @param the alternate [EMAIL PROTECTED] Boolean}
+ * @param key the desired parameter's key
+ * @param alternate the alternate [EMAIL PROTECTED] Boolean}
* @return a [EMAIL PROTECTED] Boolean} for the specified key or the specified
* alternate if no matching parameter is found
*/
@@ -218,7 +218,7 @@
/**
- * @param the desired parameter's key
+ * @param key the desired parameter's key
* @return a [EMAIL PROTECTED] Number} for the specified key or
* <code>null</code> if no matching parameter is found
*/
@@ -242,8 +242,8 @@
/**
- * @param the desired parameter's key
- * @param the alternate Number
+ * @param key the desired parameter's key
+ * @param alternate The alternate Number
* @return a Number for the specified key or the specified
* alternate if no matching parameter is found
*/
@@ -255,8 +255,8 @@
/**
- * @param the desired parameter's key
- * @param the alternate int value
+ * @param key the desired parameter's key
+ * @param alternate The alternate int value
* @return the int value for the specified key or the specified
* alternate value if no matching parameter is found
*/
@@ -268,8 +268,8 @@
/**
- * @param the desired parameter's key
- * @param the alternate double value
+ * @param key the desired parameter's key
+ * @param alternate The alternate double value
* @return the double value for the specified key or the specified
* alternate value if no matching parameter is found
*/
@@ -281,7 +281,7 @@
/**
- * @param the key for the desired parameter
+ * @param key the key for the desired parameter
* @return an array of String objects containing all of the values
* the given request parameter has, or <code>null</code>
* if the parameter does not exist
@@ -293,7 +293,7 @@
/**
- * @param the key for the desired parameter
+ * @param key the key for the desired parameter
* @return an array of Number objects for the specified key or
* <code>null</code> if the parameter does not exist or the
* parameter does not contain Numbers.
@@ -326,7 +326,7 @@
/**
- * @param the key for the desired parameter
+ * @param key the key for the desired parameter
* @return an array of int values for the specified key or
* <code>null</code> if the parameter does not exist or the
* parameter does not contain ints.
@@ -359,7 +359,7 @@
/**
- * @param the key for the desired parameter
+ * @param key the key for the desired parameter
* @return an array of double values for the specified key or
* <code>null</code> if the parameter does not exist or the
* parameter does not contain doubles.
Index: src/java/org/apache/velocity/tools/view/tools/ViewRenderTool.java
===================================================================
RCS file:
/home/cvspublic/jakarta-velocity-tools/src/java/org/apache/velocity/tools/view/tools/ViewRenderTool.java,v
retrieving revision 1.4
diff -u -r1.4 ViewRenderTool.java
--- src/java/org/apache/velocity/tools/view/tools/ViewRenderTool.java 18 Feb 2004
20:06:11 -0000 1.4
+++ src/java/org/apache/velocity/tools/view/tools/ViewRenderTool.java 10 Mar 2004
23:44:22 -0000
@@ -28,8 +28,8 @@
/**
* This tool expose methods to evaluate the given
* strings as VTL (Velocity Template Language)
- * and automatically using the current context.<br>
- *
+ * and automatically using the current context.
+ * <br />
* <pre>
* Example of eval():
* Input
Index: src/java/org/apache/velocity/tools/view/tools/package.html
===================================================================
RCS file:
/home/cvspublic/jakarta-velocity-tools/src/java/org/apache/velocity/tools/view/tools/package.html,v
retrieving revision 1.2
diff -u -r1.2 package.html
--- src/java/org/apache/velocity/tools/view/tools/package.html 22 Mar 2003 20:33:09
-0000 1.2
+++ src/java/org/apache/velocity/tools/view/tools/package.html 10 Mar 2004 23:44:23
-0000
@@ -10,7 +10,7 @@
</head>
<body bgcolor="white">
-Provides the ViewTool interface and several useful implementing classes.
+<p>Provides the ViewTool interface and several useful implementing classes.</p>--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
