yoavs 2004/08/31 16:52:52
Modified: http11/src/java/org/apache/coyote/http11
Http11Processor.java InternalOutputBuffer.java
jk/java/org/apache/ajp Ajp13.java RequestHandler.java
jk/java/org/apache/ajp/tomcat4/config ApacheConfig.java
BaseJkConfig.java IISConfig.java NSConfig.java
jk/java/org/apache/jk/common MsgAjp.java
jk/java/org/apache/jk/core Msg.java
util/java/org/apache/tomcat/util/digester
CallMethodRule.java NodeCreateRule.java
Log:
Additional minor JavaDoc fixes.
Revision Changes Path
1.106 +2 -2
jakarta-tomcat-connectors/http11/src/java/org/apache/coyote/http11/Http11Processor.java
Index: Http11Processor.java
===================================================================
RCS file:
/home/cvs/jakarta-tomcat-connectors/http11/src/java/org/apache/coyote/http11/Http11Processor.java,v
retrieving revision 1.105
retrieving revision 1.106
diff -u -r1.105 -r1.106
--- Http11Processor.java 23 Aug 2004 19:29:35 -0000 1.105
+++ Http11Processor.java 31 Aug 2004 23:52:51 -0000 1.106
@@ -399,7 +399,7 @@
* The mime-type String will be exactly matched
* in the response mime-type header .
*
- * @param userAgent user-agent string
+ * @param mimeType mime-type string
*/
public void addCompressableMimeType(String mimeType) {
compressableMimeTypes =
@@ -698,7 +698,7 @@
/** Get the request associated with this processor.
*
- * @return
+ * @return The request
*/
public Request getRequest() {
return request;
1.23 +1 -1
jakarta-tomcat-connectors/http11/src/java/org/apache/coyote/http11/InternalOutputBuffer.java
Index: InternalOutputBuffer.java
===================================================================
RCS file:
/home/cvs/jakarta-tomcat-connectors/http11/src/java/org/apache/coyote/http11/InternalOutputBuffer.java,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- InternalOutputBuffer.java 15 Jul 2004 14:33:38 -0000 1.22
+++ InternalOutputBuffer.java 31 Aug 2004 23:52:51 -0000 1.23
@@ -643,7 +643,7 @@
* buffer to the output stream, without filtering. This method is meant to
* be used to write the response header.
*
- * @param bc data to be written
+ * @param cc data to be written
*/
protected void write(CharChunk cc) {
1.29 +0 -4 jakarta-tomcat-connectors/jk/java/org/apache/ajp/Ajp13.java
Index: Ajp13.java
===================================================================
RCS file: /home/cvs/jakarta-tomcat-connectors/jk/java/org/apache/ajp/Ajp13.java,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -r1.28 -r1.29
--- Ajp13.java 24 Feb 2004 08:48:43 -0000 1.28
+++ Ajp13.java 31 Aug 2004 23:52:52 -0000 1.29
@@ -38,8 +38,6 @@
* translates from Tomcat's internal servlet support methods
* (e.g. doWrite) to the correct packets to send to the web server.
*
- * @see Ajp13Interceptor
- *
* @author Dan Milstein [EMAIL PROTECTED]
* @author Keith Wannamaker [EMAIL PROTECTED]
* @author Kevin Seguin [EMAIL PROTECTED]
@@ -479,8 +477,6 @@
* Close the socket connection to the web server. In general, sockets
* are maintained across many requests, so this will not be called
* after finish().
- *
- * @see Ajp13Interceptor#processConnection
*/
public void close() throws IOException {
if (debug > 0) {
1.22 +0 -4
jakarta-tomcat-connectors/jk/java/org/apache/ajp/RequestHandler.java
Index: RequestHandler.java
===================================================================
RCS file:
/home/cvs/jakarta-tomcat-connectors/jk/java/org/apache/ajp/RequestHandler.java,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- RequestHandler.java 15 Jun 2004 20:37:10 -0000 1.21
+++ RequestHandler.java 31 Aug 2004 23:52:52 -0000 1.22
@@ -625,8 +625,6 @@
/**
* Return the next byte of request body data (to a servlet).
- *
- * @see Request#doRead
*/
public int doRead(Ajp13 ch) throws IOException
{
@@ -651,8 +649,6 @@
*
* @return The number of bytes actually copied into the buffer, or -1
* if the end of the stream has been reached.
- *
- * @see Request#doRead
*/
public int doRead(Ajp13 ch, byte[] b, int off, int len) throws IOException
{
1.8 +2 -2
jakarta-tomcat-connectors/jk/java/org/apache/ajp/tomcat4/config/ApacheConfig.java
Index: ApacheConfig.java
===================================================================
RCS file:
/home/cvs/jakarta-tomcat-connectors/jk/java/org/apache/ajp/tomcat4/config/ApacheConfig.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- ApacheConfig.java 26 May 2004 19:32:29 -0000 1.7
+++ ApacheConfig.java 31 Aug 2004 23:52:52 -0000 1.8
@@ -162,7 +162,7 @@
then it will be resolved absolutely against
the getConfigHome() path.
<p>
- @param <b>path</b> String path to a file
+ @param path String path to a file
*/
public void setJkConfig(String path){
jkConfig= (path==null)?null:new File(path);
@@ -170,7 +170,7 @@
/**
set the path to the mod_jk Apache Module
- @param <b>path</b> String path to a file
+ @param path String path to a file
*/
public void setModJk(String path){
modJk=( path==null?null:new File(path));
1.6 +8 -8
jakarta-tomcat-connectors/jk/java/org/apache/ajp/tomcat4/config/BaseJkConfig.java
Index: BaseJkConfig.java
===================================================================
RCS file:
/home/cvs/jakarta-tomcat-connectors/jk/java/org/apache/ajp/tomcat4/config/BaseJkConfig.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- BaseJkConfig.java 24 Feb 2004 08:48:44 -0000 1.5
+++ BaseJkConfig.java 31 Aug 2004 23:52:52 -0000 1.6
@@ -211,8 +211,8 @@
executes the ApacheConfig interceptor. This method generates apache
configuration files for use with mod_jk.
<p>
- @param <b>context</b> a Context object.
- @param <b>mod_jk</b> Writer for output.
+ @param context a Context object.
+ @param mod_jk Writer for output.
*/
public void executeContext(Context context, PrintWriter mod_jk){
@@ -288,7 +288,7 @@
<p>
If not set, execute() will set this to TOMCAT_HOME.
<p>
- @param <b>dir</b> - path to a directory
+ @param dir - path to a directory
*/
public void setConfigHome(String dir){
if( dir==null ) return;
@@ -303,7 +303,7 @@
/**
set a path to the workers.properties file.
- @param <b>path</b> String path to workers.properties file
+ @param path String path to workers.properties file
*/
public void setWorkersConfig(String path){
workersConfig= (path==null?null:new File(path));
@@ -311,7 +311,7 @@
/**
set the path to the log file
- @param <b>path</b> String path to a file
+ @param path String path to a file
*/
public void setJkLog(String path){
jkLog= ( path==null?null:new File(path));
@@ -325,8 +325,8 @@
}
/**
- set the Ajp protocal
- @param <b>protocal</b> String protocol, "ajp12" or "ajp13"
+ Set the AJP worker.
+ @param worker The worker name
*/
public void setJkWorker(String worker){
jkWorker = worker;
1.6 +2 -2
jakarta-tomcat-connectors/jk/java/org/apache/ajp/tomcat4/config/IISConfig.java
Index: IISConfig.java
===================================================================
RCS file:
/home/cvs/jakarta-tomcat-connectors/jk/java/org/apache/ajp/tomcat4/config/IISConfig.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- IISConfig.java 24 Feb 2004 08:48:44 -0000 1.5
+++ IISConfig.java 31 Aug 2004 23:52:52 -0000 1.6
@@ -114,7 +114,7 @@
then getRegConfig() will resolve it absolutely against
the getConfigHome() path.
<p>
- @param <b>path</b> String path to a file
+ @param path String path to a file
*/
public void setRegConfig(String path){
regConfig= (path==null)?null:new File(path);
@@ -122,7 +122,7 @@
/**
set a path to the uriworkermap.properties file.
- @param <b>path</b> String path to uriworkermap.properties file
+ @param path String path to uriworkermap.properties file
*/
public void setUriConfig(String path){
uriConfig= (path==null?null:new File(path));
1.7 +3 -3
jakarta-tomcat-connectors/jk/java/org/apache/ajp/tomcat4/config/NSConfig.java
Index: NSConfig.java
===================================================================
RCS file:
/home/cvs/jakarta-tomcat-connectors/jk/java/org/apache/ajp/tomcat4/config/NSConfig.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- NSConfig.java 24 Feb 2004 08:48:44 -0000 1.6
+++ NSConfig.java 31 Aug 2004 23:52:52 -0000 1.7
@@ -131,7 +131,7 @@
then getRegConfig() will resolve it absolutely against
the getConfigHome() path.
<p>
- @param <b>path</b> String path to a file
+ @param path String path to a file
*/
public void setObjConfig(String path) {
objConfig= (path==null)?null:new File(path);
@@ -139,7 +139,7 @@
/**
set the path to the nsapi plugin module
- @param <b>path</b> String path to a file
+ @param path String path to a file
*/
public void setNsapiJk(String path) {
nsapiJk=( path==null?null:new File(path));
@@ -148,7 +148,7 @@
/**
Set the name for the Object that implements the
jk_service call.
- @param <b>name</b> Name of the obj.conf Object
+ @param name Name of the obj.conf Object
*/
public void setObjectName(String name) {
objectName = name;
1.17 +2 -2
jakarta-tomcat-connectors/jk/java/org/apache/jk/common/MsgAjp.java
Index: MsgAjp.java
===================================================================
RCS file:
/home/cvs/jakarta-tomcat-connectors/jk/java/org/apache/jk/common/MsgAjp.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- MsgAjp.java 24 Feb 2004 08:48:42 -0000 1.16
+++ MsgAjp.java 31 Aug 2004 23:52:52 -0000 1.17
@@ -29,7 +29,7 @@
* Can be used (somewhat confusingly) for both incoming and outgoing
* packets.
*
- * @see Ajp14/Ajp13Packet
+ * See Ajp14/Ajp13Packet.java.
*
* @author Henri Gomez [EMAIL PROTECTED]
* @author Dan Milstein [EMAIL PROTECTED]
@@ -156,7 +156,7 @@
*
* @param b The array from which to copy bytes.
* @param off The offset into the array at which to start copying
- * @param len The number of bytes to copy.
+ * @param numBytes The number of bytes to copy.
*/
public void appendBytes( byte b[], int off, int numBytes ) {
appendInt( numBytes );
1.10 +1 -1 jakarta-tomcat-connectors/jk/java/org/apache/jk/core/Msg.java
Index: Msg.java
===================================================================
RCS file: /home/cvs/jakarta-tomcat-connectors/jk/java/org/apache/jk/core/Msg.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- Msg.java 24 Feb 2004 08:48:43 -0000 1.9
+++ Msg.java 31 Aug 2004 23:52:52 -0000 1.10
@@ -74,7 +74,7 @@
*
* @param b The array from which to copy bytes.
* @param off The offset into the array at which to start copying
- * @param len The number of bytes to copy.
+ * @param numBytes The number of bytes to copy.
*/
public abstract void appendBytes( byte b[], int off, int numBytes );
1.4 +8 -6
jakarta-tomcat-connectors/util/java/org/apache/tomcat/util/digester/CallMethodRule.java
Index: CallMethodRule.java
===================================================================
RCS file:
/home/cvs/jakarta-tomcat-connectors/util/java/org/apache/tomcat/util/digester/CallMethodRule.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- CallMethodRule.java 29 Aug 2004 17:14:42 -0000 1.3
+++ CallMethodRule.java 31 Aug 2004 23:52:52 -0000 1.4
@@ -37,13 +37,15 @@
* using <code>org.apache.commons.beanutils.ConvertUtils</code>.
* </p>
*
- * <p>This rule now uses [EMAIL PROTECTED]
org.apache.commons.beanutils.MethodUtils#invokeMethod}
- * by default.
+ * <p>This rule now uses
+ * <a
href="http://jakarta.apache.org/commons/beanutils/apidocs/org/apache/commons/beanutils/MethodUtils.html";>
+ * org.apache.commons.beanutils.MethodUtils#invokeMethod
+ * </a> by default.
* This increases the kinds of methods successfully and allows primitives
* to be matched by passing in wrapper classes.
- * There are rare cases when [EMAIL PROTECTED]
org.apache.commons.beanutils.MethodUtils#invokeExactMethod}
- * (the old defualt) is required.
- * This method is much stricter in it's reflection.
+ * There are rare cases when
org.apache.commons.beanutils.MethodUtils#invokeExactMethod
+ * (the old default) is required.
+ * This method is much stricter in its reflection.
* Setting the <code>UseExactMatch</code> to true reverts to the use of this
* method.</p>
*
1.3 +2 -2
jakarta-tomcat-connectors/util/java/org/apache/tomcat/util/digester/NodeCreateRule.java
Index: NodeCreateRule.java
===================================================================
RCS file:
/home/cvs/jakarta-tomcat-connectors/util/java/org/apache/tomcat/util/digester/NodeCreateRule.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- NodeCreateRule.java 29 Aug 2004 17:14:42 -0000 1.2
+++ NodeCreateRule.java 31 Aug 2004 23:52:52 -0000 1.3
@@ -373,7 +373,7 @@
/**
* Implemented to replace the content handler currently in use by a
- * [EMAIL PROTECTED] #NodeBuilder NodeCreateRule.NodeBuilder}.
+ * NodeBuilder.
*
* @param namespaceURI the namespace URI of the matching element, or an
* empty string if the parser is not namespace aware or the element has
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
