Author: tv
Date: Wed Sep 9 07:01:49 2009
New Revision: 812786
URL: http://svn.apache.org/viewvc?rev=812786&view=rev
Log:
Fix JavaDoc warnings
Modified:
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/CookieParser.java
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/DefaultCookieParser.java
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/DefaultParameterParser.java
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/ParameterParser.java
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/ParserService.java
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/ValueParser.java
Modified:
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/CookieParser.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/CookieParser.java?rev=812786&r1=812785&r2=812786&view=diff
==============================================================================
---
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/CookieParser.java
(original)
+++
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/CookieParser.java
Wed Sep 9 07:01:49 2009
@@ -59,17 +59,18 @@
static final int AGE_DELETE = 0;
/**
- * Gets the parsed RunData.
+ * Gets the servlet request.
*
- * @return the parsed RunData object or null.
+ * @return the servlet request object or null.
*/
HttpServletRequest getRequest();
/**
- * Sets the RunData to be parsed.
+ * Sets the servlet request and response to be parsed.
* All previous cookies will be cleared.
*
- * @param data the RunData object.
+ * @param request the servlet request object.
+ * @param response the servlet response object
*/
void setData (HttpServletRequest request,
HttpServletResponse response);
Modified:
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/DefaultCookieParser.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/DefaultCookieParser.java?rev=812786&r1=812785&r2=812786&view=diff
==============================================================================
---
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/DefaultCookieParser.java
(original)
+++
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/DefaultCookieParser.java
Wed Sep 9 07:01:49 2009
@@ -59,7 +59,7 @@
{
/**
- * The run data to parse.
+ * The servlet request objects to parse.
*/
private HttpServletRequest request;
private HttpServletResponse response;
@@ -82,9 +82,9 @@
}
/**
- * Gets the parsed RunData.
+ * Gets the servlet request.
*
- * @return the parsed RunData object or null.
+ * @return the servlet request object or null.
*/
public HttpServletRequest getRequest()
{
@@ -92,10 +92,11 @@
}
/**
- * Sets the RunData to be parsed.
+ * Sets the servlet request and response to be parsed.
* All previous cookies will be cleared.
*
- * @param data the RunData object.
+ * @param request the servlet request object.
+ * @param response the servlet response object
*/
public void setData (HttpServletRequest request,
HttpServletResponse response)
Modified:
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/DefaultParameterParser.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/DefaultParameterParser.java?rev=812786&r1=812785&r2=812786&view=diff
==============================================================================
---
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/DefaultParameterParser.java
(original)
+++
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/DefaultParameterParser.java
Wed Sep 9 07:01:49 2009
@@ -269,7 +269,7 @@
/**
* Gets the uploadData byte[]
*
- * @returns uploadData A byte[] with data.
+ * @return uploadData A byte[] with data.
*/
public byte[] getUploadData ()
{
Modified:
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/ParameterParser.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/ParameterParser.java?rev=812786&r1=812785&r2=812786&view=diff
==============================================================================
---
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/ParameterParser.java
(original)
+++
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/ParameterParser.java
Wed Sep 9 07:01:49 2009
@@ -86,7 +86,7 @@
/**
* Gets the uploadData byte[]
*
- * @returns uploadData A byte[] with data.
+ * @return uploadData A byte[] with data.
*/
byte[] getUploadData ();
Modified:
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/ParserService.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/ParserService.java?rev=812786&r1=812785&r2=812786&view=diff
==============================================================================
---
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/ParserService.java
(original)
+++
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/ParserService.java
Wed Sep 9 07:01:49 2009
@@ -79,7 +79,7 @@
* multipart request will be performed automatically by {...@link
* org.apache.fulcrum.parser.ParameterParser}. Otherwise, an {...@link
* org.apache.turbine.modules.Action} may decide to parse the
- * request by calling {...@link #parseRequest(HttpServletRequest, String)
+ * request by calling {...@link #parseUpload(HttpServletRequest)
* parseRequest} manually.
*/
boolean AUTOMATIC_DEFAULT = false;
@@ -108,7 +108,7 @@
* @return a new String.
*
*/
- String convertAndTrim(String s);
+ String convertAndTrim(String value);
/**
* A convert method, which trims the string data and applies the
Modified:
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/ValueParser.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/ValueParser.java?rev=812786&r1=812785&r2=812786&view=diff
==============================================================================
---
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/ValueParser.java
(original)
+++
turbine/fulcrum/trunk/parser/src/java/org/apache/fulcrum/parser/ValueParser.java
Wed Sep 9 07:01:49 2009
@@ -709,7 +709,7 @@
* @return a new String.
*
*/
- String convertAndTrim(String s);
+ String convertAndTrim(String value);
/**
* A static version of the convert method, which
@@ -718,9 +718,9 @@
* string so that it does not destroy the value data.
*
* @param value A String to be processed.
- * @return A new String converted to lowercase and trimmed.
+ * @return A new String converted and trimmed.
*/
- String convertAndTrim(String s, int folding);
+ String convertAndTrim(String value, int folding);
/**
* Gets the folding value from the ParserService configuration
