Author: markt
Date: Mon Jan 27 19:31:53 2014
New Revision: 1561803

URL: http://svn.apache.org/r1561803
Log:
Fix Javadoc warnings

Modified:
    tomcat/tc6.0.x/trunk/java/org/apache/naming/HandlerRef.java
    tomcat/tc6.0.x/trunk/java/org/apache/naming/ServiceRef.java
    tomcat/tc6.0.x/trunk/java/org/apache/tomcat/buildutil/Txt2Html.java
    tomcat/tc6.0.x/trunk/java/org/apache/tomcat/jni/SSL.java
    
tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/http/fileupload/package.html
    tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/modeler/BaseModelMBean.java
    tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/AprEndpoint.java
    tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/JIoEndpoint.java
    
tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/NioBlockingSelector.java
    tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/NioChannel.java
    tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/NioEndpoint.java
    tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/SecureNioChannel.java

Modified: tomcat/tc6.0.x/trunk/java/org/apache/naming/HandlerRef.java
URL: 
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/naming/HandlerRef.java?rev=1561803&r1=1561802&r2=1561803&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/naming/HandlerRef.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/naming/HandlerRef.java Mon Jan 27 
19:31:53 2014
@@ -14,8 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */ 
-
-
 package org.apache.naming;
 
 import java.util.Enumeration;
@@ -30,7 +28,6 @@ import javax.naming.StringRefAddr;
  *
  * @author Fabien Carrion
  */
-
 public class HandlerRef
     extends Reference {
 
@@ -96,21 +93,11 @@ public class HandlerRef
     // ----------------------------------------------------------- Constructors
 
 
-    /**
-     * Service Reference.
-     * 
-     * @param serviceClass Service class
-     */
     public HandlerRef(String refname, String handlerClass) {
         this(refname, handlerClass, null, null);
     }
 
 
-    /**
-     * Service Reference.
-     * 
-     * @param serviceClass Service class
-     */
     public HandlerRef(String refname, String handlerClass,
                     String factory, String factoryLocation) {
         super(refname, factory, factoryLocation);
@@ -179,9 +166,4 @@ public class HandlerRef
         return (sb.toString());
 
     }
-
-
-    // ------------------------------------------------------------- Properties
-
-
 }

Modified: tomcat/tc6.0.x/trunk/java/org/apache/naming/ServiceRef.java
URL: 
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/naming/ServiceRef.java?rev=1561803&r1=1561802&r2=1561803&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/naming/ServiceRef.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/naming/ServiceRef.java Mon Jan 27 
19:31:53 2014
@@ -91,12 +91,6 @@ public class ServiceRef
 
     // ----------------------------------------------------------- Constructors
 
-
-    /**
-     * Service Reference.
-     * 
-     * @param serviceClass Service class
-     */
     public ServiceRef(String refname, String serviceInterface, String[] 
serviceQname, 
                        String wsdl, String jaxrpcmapping) {
         this(refname, serviceInterface, serviceQname, wsdl, jaxrpcmapping,
@@ -104,11 +98,6 @@ public class ServiceRef
     }
 
 
-    /**
-     * Service Reference.
-     * 
-     * @param serviceClass Service class
-     */
     public ServiceRef(String refname, String serviceInterface, String[] 
serviceQname, 
                        String wsdl, String jaxrpcmapping,
                        String factory, String factoryLocation) {
@@ -208,9 +197,4 @@ public class ServiceRef
         return (sb.toString());
 
     }
-
-
-    // ------------------------------------------------------------- Properties
-
-
 }

Modified: tomcat/tc6.0.x/trunk/java/org/apache/tomcat/buildutil/Txt2Html.java
URL: 
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/tomcat/buildutil/Txt2Html.java?rev=1561803&r1=1561802&r2=1561803&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/tomcat/buildutil/Txt2Html.java 
(original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/tomcat/buildutil/Txt2Html.java Mon Jan 
27 19:31:53 2014
@@ -63,7 +63,7 @@ public class Txt2Html 
     /**
      * Sets the files to be converted into HTML
      *
-     * @param fileset The fileset to be converted.
+     * @param fs The fileset to be converted.
      */
     public void addFileset( FileSet fs ) {
         filesets.add( fs );
@@ -72,8 +72,8 @@ public class Txt2Html 
     /**
      * Perform the conversion
      *
-     * @param BuildException Thrown if an error occurs during execution of
-     *    this task.
+     * @throws BuildException Thrown if an error occurs during execution of 
this
+     * task.
      */
     public void execute() 
         throws BuildException 

Modified: tomcat/tc6.0.x/trunk/java/org/apache/tomcat/jni/SSL.java
URL: 
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/tomcat/jni/SSL.java?rev=1561803&r1=1561802&r2=1561803&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/tomcat/jni/SSL.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/tomcat/jni/SSL.java Mon Jan 27 
19:31:53 2014
@@ -339,8 +339,8 @@ public final class SSL {
      * Return true if all the requested SSL_OP_* are supported by OpenSSL.
      * 
      * <i>Note that for versions of tcnative &lt; 1.1.25, this method will
-     * return <code>true</code> if and only if <code>op</code>=
-     * {@link #SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION} and tcnative
+     * return <code>true</code> if and only if <code>op=0x00040000</code>
+     * (SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION) and tcnative
      * supports that flag.</i>
      *
      * @param op Bitwise-OR of all SSL_OP_* to test.

Modified: 
tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/http/fileupload/package.html
URL: 
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/http/fileupload/package.html?rev=1561803&r1=1561802&r2=1561803&view=diff
==============================================================================
--- 
tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/http/fileupload/package.html 
(original)
+++ 
tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/http/fileupload/package.html 
Mon Jan 27 19:31:53 2014
@@ -21,18 +21,21 @@
    </head>
    <body>
       <p>
+         This is a packaged renamed copy of Apache Commons File Upload
+      </p>
+      <p>
          Component for handling html file uploads as given by rfc 1867
          <a href="http://www.ietf.org/rfc/rfc1867.txt";>RFC&nbsp;1867</a>.
       </p>
       <p>
          Normal usage of the package involves
-         {@link org.apache.commons.fileupload.DiskFileUpload DiskFileUpload}
+         {@link org.apache.tomcat.util.http.fileupload.DiskFileUpload 
DiskFileUpload}
          parsing the HttpServletRequest and returning a list of
-         {@link org.apache.commons.fileupload.FileItem FileItem}'s.
+         {@link org.apache.tomcat.util.http.fileupload.FileItem FileItem}'s.
          These <code>FileItem</code>'s provide easy access to the data
          given in the upload.  There is also a low level api for
          manipulating the upload data encapsulated in the
-         {@link org.apache.commons.fileupload.MultipartStream MultipartStream}
+         {@link org.apache.tomcat.util.http.fileupload.MultipartStream 
MultipartStream}
          class.
       </p>
 

Modified: 
tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/modeler/BaseModelMBean.java
URL: 
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/modeler/BaseModelMBean.java?rev=1561803&r1=1561802&r2=1561803&view=diff
==============================================================================
--- 
tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/modeler/BaseModelMBean.java 
(original)
+++ 
tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/modeler/BaseModelMBean.java 
Mon Jan 27 19:31:53 2014
@@ -1063,44 +1063,6 @@ public class BaseModelMBean implements D
         }
     }
 
-//    public void setRegistry(Registry registry) {
-//        this.registry = registry;
-//    }
-//
-//    public Registry getRegistry() {
-//        // XXX Need a better solution - to avoid the static
-//        if( registry == null )
-//            registry=Registry.getRegistry();
-//
-//        return registry;
-//    }
-
-    // ------------------------------------------------------ Protected Methods
-
-
-    /**
-     * Create and return a default <code>ModelMBeanInfo</code> object.
-     */
-//    protected ModelMBeanInfo createDefaultModelMBeanInfo() {
-//
-//        return (new ModelMBeanInfoSupport(this.getClass().getName(),
-//                                          "Default ModelMBean",
-//                                          null, null, null, null));
-//
-//    }
-
-    /**
-     * Is the specified <code>ModelMBeanInfo</code> instance valid?
-     *
-     * <p><strong>IMPLEMENTATION NOTE</strong> - This implementation
-     * does not check anything, but this method can be overridden
-     * as required.</p>
-     *
-     * @param info The <code>ModelMBeanInfo object to check
-     */
-//    protected boolean isModelMBeanInfoValid(ModelMBeanInfo info) {
-//        return (true);
-//    }
 
     // -------------------- Registration  --------------------
     // XXX We can add some method patterns here- like setName() and

Modified: tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/AprEndpoint.java
URL: 
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/AprEndpoint.java?rev=1561803&r1=1561802&r2=1561803&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/AprEndpoint.java 
(original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/AprEndpoint.java Mon 
Jan 27 19:31:53 2014
@@ -2157,10 +2157,10 @@ public class AprEndpoint extends Abstrac
         }
 
         /**
-         * Put the object into the queue. If the queue is full (for example if
-         * the queue has been reduced in size) the object will be dropped.
+         * Put the worker into the queue. If the queue is full (for example if
+         * the queue has been reduced in size) the worker will be dropped.
          *
-         * @param   object  the object to be appended to the queue (first
+         * @param   worker  the worker to be appended to the queue (first
          *                  element).
          */
         public void push(Worker worker) {

Modified: tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/JIoEndpoint.java
URL: 
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/JIoEndpoint.java?rev=1561803&r1=1561802&r2=1561803&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/JIoEndpoint.java 
(original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/JIoEndpoint.java Mon 
Jan 27 19:31:53 2014
@@ -813,10 +813,10 @@ public class JIoEndpoint extends Abstrac
         }
         
         /** 
-         * Put the object into the queue. If the queue is full (for example if
-         * the queue has been reduced in size) the object will be dropped.
+         * Put the worker into the queue. If the queue is full (for example if
+         * the queue has been reduced in size) the worker will be dropped.
          * 
-         * @param   object  the object to be appended to the queue (first
+         * @param   worker  the worker to be appended to the queue (first
          *                  element).
          */
         public void push(Worker worker) {

Modified: 
tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/NioBlockingSelector.java
URL: 
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/NioBlockingSelector.java?rev=1561803&r1=1561802&r2=1561803&view=diff
==============================================================================
--- 
tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/NioBlockingSelector.java 
(original)
+++ 
tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/NioBlockingSelector.java 
Mon Jan 27 19:31:53 2014
@@ -137,7 +137,6 @@ public class NioBlockingSelector {
      * take up a lot of CPU cycles.
      * @param buf ByteBuffer - the buffer containing the data, we will read as 
until we have read at least one byte or we timed out
      * @param socket SocketChannel - the socket to write data to
-     * @param selector Selector - the selector to use for blocking, if null 
then a busy read will be initiated
      * @param readTimeout long - the timeout for this read operation in 
milliseconds, -1 means no timeout
      * @return int - returns the number of bytes read
      * @throws EOFException if read returns -1

Modified: tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/NioChannel.java
URL: 
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/NioChannel.java?rev=1561803&r1=1561802&r2=1561803&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/NioChannel.java 
(original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/NioChannel.java Mon 
Jan 27 19:31:53 2014
@@ -84,7 +84,6 @@ public class NioChannel implements ByteC
      * Closes this channel.
      *
      * @throws IOException If an I/O error occurs
-     * @todo Implement this java.nio.channels.Channel method
      */
     public void close() throws IOException {
         getIOChannel().socket().close();
@@ -98,7 +97,6 @@ public class NioChannel implements ByteC
      * Tells whether or not this channel is open.
      *
      * @return <tt>true</tt> if, and only if, this channel is open
-     * @todo Implement this java.nio.channels.Channel method
      */
     public boolean isOpen() {
         return sc.isOpen();
@@ -110,7 +108,6 @@ public class NioChannel implements ByteC
      * @param src The buffer from which bytes are to be retrieved
      * @return The number of bytes written, possibly zero
      * @throws IOException If some other I/O error occurs
-     * @todo Implement this java.nio.channels.WritableByteChannel method
      */
     public int write(ByteBuffer src) throws IOException {
         return sc.write(src);
@@ -122,7 +119,6 @@ public class NioChannel implements ByteC
      * @param dst The buffer into which bytes are to be transferred
      * @return The number of bytes read, possibly zero, or <tt>-1</tt> if the 
channel has reached end-of-stream
      * @throws IOException If some other I/O error occurs
-     * @todo Implement this java.nio.channels.ReadableByteChannel method
      */
     public int read(ByteBuffer dst) throws IOException {
         return sc.read(dst);
@@ -136,12 +132,7 @@ public class NioChannel implements ByteC
         if (key != null && att != null && remove ) key.attach(null);
         return att;
     }
-    /**
-     * getBufHandler
-     *
-     * @return ApplicationBufferHandler
-     * @todo Implement this org.apache.tomcat.util.net.SecureNioChannel method
-     */
+
     public ApplicationBufferHandler getBufHandler() {
         return bufHandler;
     }
@@ -149,32 +140,16 @@ public class NioChannel implements ByteC
     public Poller getPoller() {
         return poller;
     }
-    /**
-     * getIOChannel
-     *
-     * @return SocketChannel
-     * @todo Implement this org.apache.tomcat.util.net.SecureNioChannel method
-     */
+
     public SocketChannel getIOChannel() {
         return sc;
     }
 
-    /**
-     * isClosing
-     *
-     * @return boolean
-     * @todo Implement this org.apache.tomcat.util.net.SecureNioChannel method
-     */
     public boolean isClosing() {
         return false;
     }
 
-    /**
-     * isInitHandshakeComplete
-     *
-     * @return boolean
-     * @todo Implement this org.apache.tomcat.util.net.SecureNioChannel method
-     */
+
     public boolean isInitHandshakeComplete() {
         return true;
     }
@@ -200,8 +175,7 @@ public class NioChannel implements ByteC
     }
     
     /**
-     * Return true if the buffer wrote data
-     * @return
+     * Return true if the buffer wrote data.
      * @throws IOException
      */
     public boolean flushOutbound() throws IOException {
@@ -215,6 +189,4 @@ public class NioChannel implements ByteC
     public void setSendFile(boolean s) {
         this.sendFile = s;
     }
-    
-
 }

Modified: tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/NioEndpoint.java
URL: 
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/NioEndpoint.java?rev=1561803&r1=1561802&r2=1561803&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/NioEndpoint.java 
(original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/NioEndpoint.java Mon 
Jan 27 19:31:53 2014
@@ -519,7 +519,6 @@ public class NioEndpoint extends Abstrac
     protected AtomicInteger pollerRotater = new AtomicInteger(0);
     /**
      * Return an available poller in true round robin fashion
-     * @return
      */
     public Poller getPoller0() {
         int idx = Math.abs(pollerRotater.incrementAndGet()) % pollers.length;
@@ -2177,10 +2176,10 @@ public class NioEndpoint extends Abstrac
         }
 
         /** 
-         * Put the object into the queue. If the queue is full (for example if
-         * the queue has been reduced in size) the object will be dropped.
+         * Put the worker into the queue. If the queue is full (for example if
+         * the queue has been reduced in size) the worker will be dropped.
          * 
-         * @param   object  the object to be appended to the queue (first
+         * @param   worker  the worker to be appended to the queue (first
          *                  element).
          */
         public void push(Worker worker) {

Modified: 
tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/SecureNioChannel.java
URL: 
http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/SecureNioChannel.java?rev=1561803&r1=1561802&r2=1561803&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/SecureNioChannel.java 
(original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/tomcat/util/net/SecureNioChannel.java 
Mon Jan 27 19:31:53 2014
@@ -285,7 +285,6 @@ public class SecureNioChannel extends Ni
      * </code></pre>
      * @throws IOException if an I/O error occurs
      * @throws IOException if there is data on the outgoing network buffer and 
we are unable to flush it
-     * @todo Implement this java.io.Closeable method
      */
     public void close() throws IOException {
         if (closing) return;
@@ -336,7 +335,6 @@ public class SecureNioChannel extends Ni
      * @return The number of bytes read, possibly zero, or <tt>-1</tt> if the 
channel has reached end-of-stream
      * @throws IOException If some other I/O error occurs
      * @throws IllegalArgumentException if the destination buffer is different 
than bufHandler.getReadBuffer()
-     * @todo Implement this java.nio.channels.ReadableByteChannel method
      */
     public int read(ByteBuffer dst) throws IOException {
         //if we want to take advantage of the expand function, make sure we 
only use the ApplicationBufferHandler's buffers
@@ -390,7 +388,6 @@ public class SecureNioChannel extends Ni
      * @param src The buffer from which bytes are to be retrieved
      * @return The number of bytes written, possibly zero
      * @throws IOException If some other I/O error occurs
-     * @todo Implement this java.nio.channels.WritableByteChannel method
      */
     public int write(ByteBuffer src) throws IOException {
         if ( src == this.netOutBuffer ) {



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org

Reply via email to