You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by jo...@apache.org on 2003/11/15 05:21:57 UTC
cvs commit: cocoon-2.2/src/java/org/apache/cocoon/components/treeprocessor TreeProcessor.java
joerg 2003/11/14 20:21:57
Modified: src/java/org/apache/cocoon/components/flow
ContinuationsDisposer.java
src/java/org/apache/cocoon/servlet/multipart
MultipartParser.java
src/java/org/apache/cocoon/util PostInputStream.java
EnumerationFactory.java
src/java/org/apache/cocoon/components/language/programming/java
JstyleFormatter.java Pizza.java Jikes.java
src/java/org/apache/cocoon/acting
AbstractValidatorAction.java
FormValidatorAction.java
src/java/org/apache/cocoon/components/modules/output
RequestAttributeMap.java
RequestAttributeOutputModule.java
SessionAttributeOutputModule.java
src/java/org/apache/cocoon/environment/commandline
CommandLineRequest.java
src/java/org/apache/cocoon/components/modules/input
LocateResource.java
src/java/org/apache/cocoon/bean Target.java
src/java/org/apache/cocoon/components/crawler
CocoonCrawler.java
src/java/org/apache/cocoon/components/treeprocessor
TreeProcessor.java
Log:
massive JavaDoc error fixing
Revision Changes Path
1.2 +1 -1 cocoon-2.2/src/java/org/apache/cocoon/components/flow/ContinuationsDisposer.java
Index: ContinuationsDisposer.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/components/flow/ContinuationsDisposer.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ContinuationsDisposer.java 26 Aug 2003 09:04:39 -0000 1.1
+++ ContinuationsDisposer.java 15 Nov 2003 04:21:57 -0000 1.2
@@ -62,7 +62,7 @@
* the invalidation of a continuation upon the {@link ContinuationsDisposer}
* object passed during the creation of the WebContinuation.
*
- * @param kont the {@link WebContinuation} value representing the
+ * @param webContinuation the {@link WebContinuation} value representing the
* continuation object.
*/
public void disposeContinuation(WebContinuation webContinuation);
1.4 +1 -3 cocoon-2.2/src/java/org/apache/cocoon/servlet/multipart/MultipartParser.java
Index: MultipartParser.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/servlet/multipart/MultipartParser.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- MultipartParser.java 29 Oct 2003 19:44:53 -0000 1.3
+++ MultipartParser.java 15 Nov 2003 04:21:57 -0000 1.4
@@ -104,8 +104,6 @@
* @param saveUploadedFilesToDisk Write fileparts to the uploadDirectory. If true the corresponding object
* in the hashtable will contain a FilePartFile, if false a FilePartArray
* @param uploadDirectory The directory to write to if saveUploadedFilesToDisk is true.
- * @param saveUploadedFilesToDisk
- * @param uploadDirectory
* @param allowOverwrite Allow existing files to be overwritten.
* @param silentlyRename If file exists rename file (using filename+number).
* @param maxUploadSize The maximum content length accepted.
1.2 +3 -3 cocoon-2.2/src/java/org/apache/cocoon/util/PostInputStream.java
Index: PostInputStream.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/util/PostInputStream.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- PostInputStream.java 9 Mar 2003 00:09:43 -0000 1.1
+++ PostInputStream.java 15 Nov 2003 04:21:57 -0000 1.2
@@ -100,7 +100,7 @@
/**
* Sets the underlying input stream and contentLen value .
*
- * @param inputStream the input stream; can not be null.
+ * @param input the input stream; can not be null.
* @param len the post message body length.
*
* @throws IllegalArgumentException
@@ -116,7 +116,7 @@
/**
* Sets the underlying input stream and contentLen value .
*
- * @param inputStream the input stream; can not be null.
+ * @param input the input stream; can not be null.
* @param len the post message body length.
*
* @throws IOException
1.3 +4 -4 cocoon-2.2/src/java/org/apache/cocoon/util/EnumerationFactory.java
Index: EnumerationFactory.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/util/EnumerationFactory.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- EnumerationFactory.java 16 Mar 2003 17:49:16 -0000 1.2
+++ EnumerationFactory.java 15 Nov 2003 04:21:57 -0000 1.3
@@ -138,13 +138,13 @@
//--------------------------------------------------------------------------
// Numeric representation:
+ public int getPos () { // Ada'Pos
+ return pos;
+ }
/**
* Access to the numeric representation.
* @param value the numeric value
*/
- public int getPos () { // Ada'Pos
- return pos;
- }
public static EnumerationFactory getVal (int value) { // Ada'Val
return (EnumerationFactory) allObjects.elementAt (value);
}
1.2 +4 -3 cocoon-2.2/src/java/org/apache/cocoon/components/language/programming/java/JstyleFormatter.java
Index: JstyleFormatter.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/components/language/programming/java/JstyleFormatter.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- JstyleFormatter.java 9 Mar 2003 00:09:00 -0000 1.1
+++ JstyleFormatter.java 15 Nov 2003 04:21:57 -0000 1.2
@@ -127,9 +127,10 @@
* The encoding can be <code>null</code> for the platform's default
* encoding
*
- * @param PARAM_NAME Param description
+ * @param out
+ * @param encoding
* @return the value
- * @exception EXCEPTION_NAME If an error occurs
+ * @exception UnsupportedEncodingException
*/
protected String getString(ByteArrayOutputStream out, String encoding)
throws UnsupportedEncodingException
1.2 +2 -6 cocoon-2.2/src/java/org/apache/cocoon/components/language/programming/java/Pizza.java
Index: Pizza.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/components/language/programming/java/Pizza.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Pizza.java 9 Mar 2003 00:09:00 -0000 1.1
+++ Pizza.java 15 Nov 2003 04:21:57 -0000 1.2
@@ -89,11 +89,7 @@
/**
* Compile a source file yielding a loadable class file.
*
- * @param filename The object program base file name
- * @param baseDirectory The directory containing the object program file
- * @param encoding The encoding expected in the source file or
- * <code>null</code> if it is the platform's default encoding
- * @exception LanguageException If an error occurs during compilation
+ * @exception IOException
*/
public boolean compile() throws IOException {
1.3 +2 -2 cocoon-2.2/src/java/org/apache/cocoon/components/language/programming/java/Jikes.java
Index: Jikes.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/components/language/programming/java/Jikes.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Jikes.java 24 Mar 2003 14:33:57 -0000 1.2
+++ Jikes.java 15 Nov 2003 04:21:57 -0000 1.3
@@ -190,7 +190,7 @@
* Parse the compiler error stream to produce a list of
* <code>CompilerError</code>s
*
- * @param errors The error stream
+ * @param input The error stream
* @return The list of compiler error messages
* @exception IOException If an error occurs during message collection
*/
1.8 +9 -9 cocoon-2.2/src/java/org/apache/cocoon/acting/AbstractValidatorAction.java
Index: AbstractValidatorAction.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/acting/AbstractValidatorAction.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- AbstractValidatorAction.java 27 Oct 2003 07:37:49 -0000 1.7
+++ AbstractValidatorAction.java 15 Nov 2003 04:21:57 -0000 1.8
@@ -224,13 +224,13 @@
implements Configurable {
/**
- * Reads parameter values for all parameters that are contained in the active
- * constraint list. If a parameter has multiple values, all are stored in the
+ * Reads parameter values for all parameters that are contained in the active
+ * constraint list. If a parameter has multiple values, all are stored in the
* resulting map.
*
* @param objectModel the object model
* @param set a collection of parameter names
- * @return
+ * @return HashMap
*/
abstract protected HashMap createMapOfParameters(Map objectModel, Collection set);
@@ -360,7 +360,7 @@
* @param params Map of parameter values to be validated
* @param isString boolean indicating if the value is string encoded
* @param type string holding the name of the datatype to validate value
- * @return
+ * @return ValidatorActionHelper
*/
protected ValidatorActionHelper validateValue(
String name,
@@ -916,7 +916,7 @@
* attribute. An empty array results in an empty map.
*
* @param descriptor
- * @return
+ * @return index map or empty map
*/
protected Map indexConfiguration(Configuration[] descriptor) {
if (descriptor == null)
@@ -935,7 +935,7 @@
*
* @param valsetstr
* @param consets
- * @return
+ * @return collection of all parameters to validate
*/
protected Collection resolveConstraints(String valsetstr, Map consets) {
/* get the list of params to be validated */
@@ -954,7 +954,7 @@
/**
* Checks the default setting for reloading the descriptor file.
- * @return
+ * @return boolean
*/
protected boolean isDescriptorReloadable() {
// read global parameter settings
@@ -998,7 +998,7 @@
* @param set
* @param params
* @param isString
- * @return
+ * @return boolean all parameters ok or not
*/
protected boolean validateSetOfParameters(
Map desc,
1.5 +2 -2 cocoon-2.2/src/java/org/apache/cocoon/acting/FormValidatorAction.java
Index: FormValidatorAction.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/acting/FormValidatorAction.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- FormValidatorAction.java 27 Oct 2003 07:28:26 -0000 1.4
+++ FormValidatorAction.java 15 Nov 2003 04:21:57 -0000 1.5
@@ -83,7 +83,7 @@
*
* @param objectModel the object model
* @param set a collection of parameter names
- * @return
+ * @return HashMap of required parameters
*/
protected HashMap createMapOfParameters(Map objectModel, Collection set) {
String name;
1.2 +2 -2 cocoon-2.2/src/java/org/apache/cocoon/components/modules/output/RequestAttributeMap.java
Index: RequestAttributeMap.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/components/modules/output/RequestAttributeMap.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- RequestAttributeMap.java 9 Mar 2003 00:09:05 -0000 1.1
+++ RequestAttributeMap.java 15 Nov 2003 04:21:57 -0000 1.2
@@ -76,7 +76,7 @@
* communicate an attribute value to further processing logic.
* @param modeConf column's mode configuration from resource
* description. This argument is optional.
- * @param request The request object
+ * @param objectModel The objectModel
* @param name The attribute's label, consisting of "table.column"
* or "table.column[index]" in case of multiple attributes of the
* same spec.
1.2 +2 -2 cocoon-2.2/src/java/org/apache/cocoon/components/modules/output/RequestAttributeOutputModule.java
Index: RequestAttributeOutputModule.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/components/modules/output/RequestAttributeOutputModule.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- RequestAttributeOutputModule.java 9 Mar 2003 00:09:05 -0000 1.1
+++ RequestAttributeOutputModule.java 15 Nov 2003 04:21:57 -0000 1.2
@@ -83,7 +83,7 @@
* communicate an attribute value to further processing logic.
* @param modeConf column's mode configuration from resource
* description. This argument is optional.
- * @param request The request object
+ * @param objectModel The objectModel
* @param name The attribute's label, consisting of "table.column"
* or "table.column[index]" in case of multiple attributes of the
* same spec.
1.2 +2 -2 cocoon-2.2/src/java/org/apache/cocoon/components/modules/output/SessionAttributeOutputModule.java
Index: SessionAttributeOutputModule.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/components/modules/output/SessionAttributeOutputModule.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SessionAttributeOutputModule.java 9 Mar 2003 00:09:05 -0000 1.1
+++ SessionAttributeOutputModule.java 15 Nov 2003 04:21:57 -0000 1.2
@@ -83,7 +83,7 @@
* communicate an attribute value to further processing logic.
* @param modeConf column's mode configuration from resource
* description. This argument is optional.
- * @param request The request object
+ * @param objectModel The objectModel
* @param name The attribute's label, consisting of "table.column"
* or "table.column[index]" in case of multiple attributes of the
* same spec.
1.4 +10 -15 cocoon-2.2/src/java/org/apache/cocoon/environment/commandline/CommandLineRequest.java
Index: CommandLineRequest.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/environment/commandline/CommandLineRequest.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- CommandLineRequest.java 6 Jul 2003 20:37:48 -0000 1.3
+++ CommandLineRequest.java 15 Nov 2003 04:21:57 -0000 1.4
@@ -262,21 +262,16 @@
* you must call this method before
* the response is committed.
*
+ * @param create <code>true</code> to create a new session for this request
+ * if necessary;
+ * <code>false</code> to return <code>null</code> if there's
+ * no current session
+ *
+ * @return the <code>Session</code> associated with this request or
+ * <code>null</code> if <code>create</code> is <code>false</code>
+ * and the request has no valid session
*
- *
- *
- * @param <code>true</code> to create
- * a new session for this request if necessary;
- * <code>false</code> to return <code>null</code>
- * if there's no current session
- *
- *
- * @return the <code>Session</code> associated
- * with this request or <code>null</code> if
- * <code>create</code> is <code>false</code>
- * and the request has no valid session
- *
- * @see #getSession()
+ * @see #getSession()
*
*
*/
1.2 +4 -4 cocoon-2.2/src/java/org/apache/cocoon/components/modules/input/LocateResource.java
Index: LocateResource.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/components/modules/input/LocateResource.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- LocateResource.java 15 Aug 2003 15:55:45 -0000 1.1
+++ LocateResource.java 15 Nov 2003 04:21:57 -0000 1.2
@@ -104,7 +104,7 @@
* Calculate the minimal length of the URL, that is the position
* of the first ":" if a protocol is provided or otherwise 0.
* @param name
- * @return
+ * @return minimal length
*/
protected int calculateMinLen(String name) {
@@ -120,7 +120,7 @@
*
* @param urlstring
* @param minLen
- * @return
+ * @return shortened URI
*/
protected String shortenURI(String urlstring, int minLen) {
@@ -154,7 +154,7 @@
* @param urlstring
* @param filename
* @param minLen
- * @return
+ * @return urlstring if resource was found, <code>null</code> otherwise
*/
protected String locateResource(String urlstring, String filename, int minLen) {
String sourcename = null;
1.9 +4 -3 cocoon-2.2/src/java/org/apache/cocoon/bean/Target.java
Index: Target.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/bean/Target.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- Target.java 31 Oct 2003 21:41:10 -0000 1.8
+++ Target.java 15 Nov 2003 04:21:57 -0000 1.9
@@ -341,7 +341,8 @@
/**
*
- * @return
+ * @return destination URI after all authentication details have been
+ * removed
*/
public String getAuthlessDestURI() throws ProcessingException {
return NetUtils.removeAuthorisation(this.getDestinationURI());
@@ -431,7 +432,7 @@
return _toString;
}
/**
- * @return
+ * @return boolean
*/
public boolean confirmExtensions() {
return confirmExtension;
1.6 +2 -2 cocoon-2.2/src/java/org/apache/cocoon/components/crawler/CocoonCrawler.java
Index: CocoonCrawler.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/components/crawler/CocoonCrawler.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- CocoonCrawler.java 30 Oct 2003 12:42:15 -0000 1.5
+++ CocoonCrawler.java 15 Nov 2003 04:21:57 -0000 1.6
@@ -85,7 +85,7 @@
* </p>
*
* @param url The URL to start crawling from
- * @param depth The maximum depth to crawl to. -1 for no maxiumum.
+ * @param maxDepth The maximum depth to crawl to. -1 for no maxiumum.
*/
void crawl(URL url, int maxDepth);
1.24 +2 -2 cocoon-2.2/src/java/org/apache/cocoon/components/treeprocessor/TreeProcessor.java
Index: TreeProcessor.java
===================================================================
RCS file: /home/cvs/cocoon-2.2/src/java/org/apache/cocoon/components/treeprocessor/TreeProcessor.java,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- TreeProcessor.java 30 Oct 2003 14:05:13 -0000 1.23
+++ TreeProcessor.java 15 Nov 2003 04:21:57 -0000 1.24
@@ -353,7 +353,7 @@
* Do the actual processing, be it producing the response or just building the pipeline
* @param environment
* @param context
- * @return
+ * @return true if the pipeline was successfully built, false otherwise.
* @throws Exception
*/
protected boolean process(Environment environment, InvokeContext context)