You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2014/01/27 19:04:52 UTC

svn commit: r1561770 - in /tomcat/tc6.0.x/trunk/java/org/apache/catalina: ha/tcp/ manager/ manager/host/ realm/ servlets/

Author: markt
Date: Mon Jan 27 18:04:52 2014
New Revision: 1561770

URL: http://svn.apache.org/r1561770
Log:
Javadoc fixes

Modified:
    tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java
    tomcat/tc6.0.x/trunk/java/org/apache/catalina/manager/StatusTransformer.java
    tomcat/tc6.0.x/trunk/java/org/apache/catalina/manager/host/HTMLHostManagerServlet.java
    tomcat/tc6.0.x/trunk/java/org/apache/catalina/manager/host/HostManagerServlet.java
    tomcat/tc6.0.x/trunk/java/org/apache/catalina/realm/CombinedRealm.java
    tomcat/tc6.0.x/trunk/java/org/apache/catalina/realm/LockOutRealm.java
    tomcat/tc6.0.x/trunk/java/org/apache/catalina/servlets/DefaultServlet.java

Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java?rev=1561770&r1=1561769&r2=1561770&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java Mon Jan 27 18:04:52 2014
@@ -14,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.apache.catalina.ha.tcp;
 
 import java.beans.PropertyChangeSupport;
@@ -499,7 +498,7 @@ public class SimpleTcpCluster 
      * @param name
      *            Context Name of this manager
      * @see org.apache.catalina.Cluster#createManager(java.lang.String)
-     * @see #addManager(String, Manager)
+     * @see #registerManager(Manager)
      * @see DeltaManager#start()
      */
     public synchronized Manager createManager(String name) {
@@ -540,7 +539,7 @@ public class SimpleTcpCluster 
     /**
      * remove an application form cluster replication bus
      * 
-     * @see org.apache.catalina.ha.CatalinaCluster#removeManager(java.lang.String,Manager)
+     * @see org.apache.catalina.ha.CatalinaCluster#removeManager(Manager)
      */
     public void removeManager(Manager manager) {
         if (manager != null && manager instanceof ClusterManager ) {
@@ -554,11 +553,6 @@ public class SimpleTcpCluster 
         }
     }
 
-    /**
-     * @param name
-     * @param manager
-     * @return
-     */
     public String getManagerName(String name, Manager manager) {
         String clusterName = name ;
         if ( clusterName == null ) clusterName = manager.getContainer().getName();
@@ -782,7 +776,7 @@ public class SimpleTcpCluster 
      * send message to all cluster members
      * @param msg message to transfer
      * 
-     * @see org.apache.catalina.ha.CatalinaCluster#send(org.apache.catalina.ha.ClusterMessage)
+     * @see org.apache.catalina.ha.CatalinaCluster#send(ClusterMessage)
      */
     public void send(ClusterMessage msg) {
         send(msg, null);
@@ -791,7 +785,7 @@ public class SimpleTcpCluster 
     /**
      * send message to all cluster members same cluster domain
      * 
-     * @see org.apache.catalina.ha.CatalinaCluster#send(org.apache.catalina.ha.ClusterMessage)
+     * @see org.apache.catalina.ha.CatalinaCluster#send(ClusterMessage)
      */
     public void sendClusterDomain(ClusterMessage msg) {
         send(msg,null);
@@ -803,8 +797,7 @@ public class SimpleTcpCluster 
      * 
      * @param msg message to transfer
      * @param dest Receiver member
-     * @see org.apache.catalina.ha.CatalinaCluster#send(org.apache.catalina.ha.ClusterMessage,
-     *      org.apache.catalina.ha.Member)
+     * @see org.apache.catalina.ha.CatalinaCluster#send(ClusterMessage,Member)
      */
     public void send(ClusterMessage msg, Member dest) {
         try {
@@ -833,7 +826,7 @@ public class SimpleTcpCluster 
     /**
      * New cluster member is registered
      * 
-     * @see org.apache.catalina.ha.MembershipListener#memberAdded(org.apache.catalina.ha.Member)
+     * @see MembershipListener#memberAdded(Member)
      */
     public void memberAdded(Member member) {
         try {
@@ -852,7 +845,7 @@ public class SimpleTcpCluster 
     /**
      * Cluster member is gone
      * 
-     * @see org.apache.catalina.ha.MembershipListener#memberDisappeared(org.apache.catalina.ha.Member)
+     * @see MembershipListener#memberDisappeared(Member)
      */
     public void memberDisappeared(Member member) {
         try {
@@ -871,11 +864,11 @@ public class SimpleTcpCluster 
     // messages
 
     /**
-     * notify all listeners from receiving a new message is not ClusterMessage
-     * emitt Failure Event to LifecylceListener
+     * Notify all listeners from receiving a new message is not ClusterMessage
+     * and emit Failure Event to LifecylceListener
      * 
-     * @param message
-     *            receveived Message
+     * @param msg
+     *            received Message
      */
     public boolean accept(Serializable msg, Member sender) {
         return (msg instanceof ClusterMessage);

Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/manager/StatusTransformer.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/manager/StatusTransformer.java?rev=1561770&r1=1561769&r2=1561770&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/manager/StatusTransformer.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/manager/StatusTransformer.java Mon Jan 27 18:04:52 2014
@@ -61,15 +61,6 @@ public class StatusTransformer {
     }
 
 
-    /**
-     * Process a GET request for the specified resource.
-     *
-     * @param request The servlet request we are processing
-     * @param response The servlet response we are creating
-     *
-     * @exception IOException if an input/output error occurs
-     * @exception ServletException if a servlet-specified error occurs
-     */
     public static void writeHeader(PrintWriter writer, int mode) {
         if (mode == 0){
             // HTML Header Section

Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/manager/host/HTMLHostManagerServlet.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/manager/host/HTMLHostManagerServlet.java?rev=1561770&r1=1561769&r2=1561770&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/manager/host/HTMLHostManagerServlet.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/manager/host/HTMLHostManagerServlet.java Mon Jan 27 18:04:52 2014
@@ -56,9 +56,7 @@ import org.apache.catalina.util.ServerIn
 * @author Glenn L. Nielsen
 * @author Peter Rossbach
 * @version $Id$
-* @see ManagerServlet
 */
-
 public final class HTMLHostManagerServlet extends HostManagerServlet {
 
     // --------------------------------------------------------- Public Methods
@@ -131,7 +129,6 @@ public final class HTMLHostManagerServle
     /**
      * Remove the specified host.
      *
-     * @param writer Writer to render results to
      * @param name host name
      */
     protected String remove(String name) {

Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/manager/host/HostManagerServlet.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/manager/host/HostManagerServlet.java?rev=1561770&r1=1561769&r2=1561770&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/manager/host/HostManagerServlet.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/manager/host/HostManagerServlet.java Mon Jan 27 18:04:52 2014
@@ -290,7 +290,6 @@ public class HostManagerServlet
      * @param parameter
      * @param theDefault
      * @param htmlMode
-     * @return
      */
     protected boolean booleanParameter(HttpServletRequest request,
             String parameter, boolean theDefault, boolean htmlMode) {

Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/realm/CombinedRealm.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/realm/CombinedRealm.java?rev=1561770&r1=1561769&r2=1561770&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/realm/CombinedRealm.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/realm/CombinedRealm.java Mon Jan 27 18:04:52 2014
@@ -125,7 +125,7 @@ public class CombinedRealm extends Realm
      *
      * @param username Username of the Principal to look up
      * @param clientDigest Digest which has been submitted by the client
-     * @param nOnce Unique (or supposedly unique) token which has been used
+     * @param once Unique (or supposedly unique) token which has been used
      * for this request
      * @param realmName Realm name
      * @param md5a2 Second MD5 digest used to calculate the digest :

Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/realm/LockOutRealm.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/realm/LockOutRealm.java?rev=1561770&r1=1561769&r2=1561770&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/realm/LockOutRealm.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/realm/LockOutRealm.java Mon Jan 27 18:04:52 2014
@@ -146,7 +146,7 @@ public class LockOutRealm extends Combin
      *
      * @param username Username of the Principal to look up
      * @param clientDigest Digest which has been submitted by the client
-     * @param nOnce Unique (or supposedly unique) token which has been used
+     * @param once Unique (or supposedly unique) token which has been used
      * for this request
      * @param realmName Realm name
      * @param md5a2 Second MD5 digest used to calculate the digest :

Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/servlets/DefaultServlet.java
URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/servlets/DefaultServlet.java?rev=1561770&r1=1561769&r2=1561770&view=diff
==============================================================================
--- tomcat/tc6.0.x/trunk/java/org/apache/catalina/servlets/DefaultServlet.java (original)
+++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/servlets/DefaultServlet.java Mon Jan 27 18:04:52 2014
@@ -1631,7 +1631,7 @@ public class DefaultServlet
      *
      * @param request The servlet request we are processing
      * @param response The servlet response we are creating
-     * @param resourceInfo File object
+     * @param resourceAttributes Attributes of requested resource
      * @return boolean true if the resource meets the specified condition,
      * and false if the condition is not satisfied, in which case request
      * processing is stopped
@@ -1676,7 +1676,7 @@ public class DefaultServlet
      *
      * @param request The servlet request we are processing
      * @param response The servlet response we are creating
-     * @param resourceInfo File object
+     * @param resourceAttributes Attributes of requested resource
      * @return boolean true if the resource meets the specified condition,
      * and false if the condition is not satisfied, in which case request
      * processing is stopped
@@ -1897,7 +1897,7 @@ public class DefaultServlet
      * output stream, and ensure that both streams are closed before returning
      * (even in the face of an exception).
      *
-     * @param resourceInfo The ResourceInfo object
+     * @param cacheEntry Cached version of requested resource
      * @param ostream The output stream to write to
      * @param range Range the client wanted to retrieve
      * @exception IOException if an input/output error occurs
@@ -1928,7 +1928,7 @@ public class DefaultServlet
      * output stream, and ensure that both streams are closed before returning
      * (even in the face of an exception).
      *
-     * @param resourceInfo The ResourceInfo object
+     * @param cacheEntry Cached version of requested resource
      * @param writer The writer to write to
      * @param range Range the client wanted to retrieve
      * @exception IOException if an input/output error occurs
@@ -1966,7 +1966,7 @@ public class DefaultServlet
      * output stream, and ensure that both streams are closed before returning
      * (even in the face of an exception).
      *
-     * @param resourceInfo The ResourceInfo object
+     * @param cacheEntry Cached version of requested resource
      * @param ostream The output stream to write to
      * @param ranges Enumeration of the ranges the client wanted to retrieve
      * @param contentType Content type of the resource
@@ -2019,7 +2019,7 @@ public class DefaultServlet
      * output stream, and ensure that both streams are closed before returning
      * (even in the face of an exception).
      *
-     * @param resourceInfo The ResourceInfo object
+     * @param cacheEntry Cached version of requested resource
      * @param writer The writer to write to
      * @param ranges Enumeration of the ranges the client wanted to retrieve
      * @param contentType Content type of the resource



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