Handful of Javadoc fixes

git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@981602 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/java/org/apache/catalina/core/ApplicationContext.java b/java/org/apache/catalina/core/ApplicationContext.java
index fde811e..bf0f513 100644 (file)
--- a/java/org/apache/catalina/core/ApplicationContext.java
+++ b/java/org/apache/catalina/core/ApplicationContext.java
@@ -864,8 +864,8 @@ public class ApplicationContext
      * @param   filterName  Name of filter to add
      * @param   filterClass Name of filter class
      * @return  <code>null</code> if the filter has already been fully defined,
-     *          else a {@link FilterRegistration.Dynamic} object that can be
-     *          used to further configure the filter
+     *          else a {@link javax.servlet.FilterRegistration.Dynamic} object
+     *          that can be used to further configure the filter
      * @throws IllegalStateException if the context has already been initialised
      * @throws UnsupportedOperationException - if this context was passed to the
      *         {@link ServletContextListener#contextInitialized(javax.servlet.ServletContextEvent)}
@@ -884,8 +884,8 @@ public class ApplicationContext
      * @param   filterName  Name of filter to add
      * @param   filter      Filter to add
      * @return  <code>null</code> if the filter has already been fully defined,
-     *          else a {@link FilterRegistration.Dynamic} object that can be
-     *          used to further configure the filter
+     *          else a {@link javax.servlet.FilterRegistration.Dynamic} object
+     *          that can be used to further configure the filter
      * @throws IllegalStateException if the context has already been initialised
      * @throws UnsupportedOperationException - if this context was passed to the
      *         {@link ServletContextListener#contextInitialized(javax.servlet.ServletContextEvent)}
@@ -904,8 +904,8 @@ public class ApplicationContext
      * @param   filterName  Name of filter to add
      * @param   filterClass Class of filter to add
      * @return  <code>null</code> if the filter has already been fully defined,
-     *          else a {@link FilterRegistration.Dynamic} object that can be
-     *          used to further configure the filter
+     *          else a {@link javax.servlet.FilterRegistration.Dynamic} object
+     *          that can be used to further configure the filter
      * @throws IllegalStateException if the context has already been initialised
      * @throws UnsupportedOperationException - if this context was passed to the
      *         {@link ServletContextListener#contextInitialized(javax.servlet.ServletContextEvent)}
@@ -993,8 +993,8 @@ public class ApplicationContext
      * @param   servletName  Name of servlet to add
      * @param   servletClass Name of servlet class
      * @return  <code>null</code> if the servlet has already been fully defined,
-     *          else a {@link ServletRegistration.Dynamic} object that can be
-     *          used to further configure the servlet
+     *          else a {@link javax.servlet.ServletRegistration.Dynamic} object
+     *          that can be used to further configure the servlet
      * @throws IllegalStateException if the context has already been initialised
      * @throws UnsupportedOperationException - if this context was passed to the
      *         {@link ServletContextListener#contextInitialized(javax.servlet.ServletContextEvent)}
@@ -1013,8 +1013,8 @@ public class ApplicationContext
      * @param   servletName Name of servlet to add
      * @param   servlet     Servlet instance to add
      * @return  <code>null</code> if the servlet has already been fully defined,
-     *          else a {@link ServletRegistration.Dynamic} object that can be
-     *          used to further configure the servlet
+     *          else a {@link javax.servlet.ServletRegistration.Dynamic} object
+     *          that can be used to further configure the servlet
      * @throws IllegalStateException if the context has already been initialised
      * @throws UnsupportedOperationException - if this context was passed to the
      *         {@link ServletContextListener#contextInitialized(javax.servlet.ServletContextEvent)}
@@ -1033,8 +1033,8 @@ public class ApplicationContext
      * @param   servletName  Name of servlet to add
      * @param   servletClass Class of servlet to add
      * @return  <code>null</code> if the servlet has already been fully defined,
-     *          else a {@link ServletRegistration.Dynamic} object that can be
-     *          used to further configure the servlet
+     *          else a {@link javax.servlet.ServletRegistration.Dynamic} object
+     *          that can be used to further configure the servlet
      * @throws IllegalStateException if the context has already been initialised
      * @throws UnsupportedOperationException - if this context was passed to the
      *         {@link ServletContextListener#contextInitialized(javax.servlet.ServletContextEvent)}

diff --git a/java/org/apache/catalina/core/StandardServer.java b/java/org/apache/catalina/core/StandardServer.java
index d715b7f..e149bd7 100644 (file)
--- a/java/org/apache/catalina/core/StandardServer.java
+++ b/java/org/apache/catalina/core/StandardServer.java
@@ -34,6 +34,7 @@ import javax.management.ObjectName;
 import org.apache.catalina.Context;
 import org.apache.catalina.LifecycleException;
 import org.apache.catalina.LifecycleState;
+import org.apache.catalina.Engine;
 import org.apache.catalina.Server;
 import org.apache.catalina.Service;
 import org.apache.catalina.deploy.NamingResources;

diff --git a/java/org/apache/catalina/filters/ExpiresFilter.java b/java/org/apache/catalina/filters/ExpiresFilter.java
index d8e1038..3ac8fd1 100644 (file)
--- a/java/org/apache/catalina/filters/ExpiresFilter.java
+++ b/java/org/apache/catalina/filters/ExpiresFilter.java
@@ -354,7 +354,7 @@ import org.apache.juli.logging.LogFactory;
  * {@link #isEligibleToExpirationHeaderGeneration(HttpServletRequest, XHttpServletResponse)}
  * </li>
  * <li>
- * {@link #getExpirationDate(HttpServletRequest, XHttpServletResponse)}</li>
+ * {@link #getExpirationDate(XHttpServletResponse)}</li>
  * </ul>
  * </p>
  * <h1>Troubleshooting</h1>
@@ -1427,7 +1427,7 @@ public class ExpiresFilter extends FilterBase {
      * </p>
      * <p>
      * Invocations to <tt>Logger.debug(...)</tt> are guarded by
-     * {@link Logger#isDebugEnabled()} because
+     * {@link Log#isDebugEnabled()} because
      * {@link HttpServletRequest#getRequestURI()} and
      * {@link HttpServletResponse#getContentType()} costs <tt>String</tt>
      * objects instantiations (as of Tomcat 7).

diff --git a/java/org/apache/catalina/ha/ClusterMessageBase.java b/java/org/apache/catalina/ha/ClusterMessageBase.java
index 2dc0efa..f5f5e44 100644 (file)
--- a/java/org/apache/catalina/ha/ClusterMessageBase.java
+++ b/java/org/apache/catalina/ha/ClusterMessageBase.java
@@ -45,7 +45,7 @@ public class ClusterMessageBase implements ClusterMessage {
      * getAddress
      *
      * @return Member
-     * @todo Implement this org.apache.catalina.ha.ClusterMessage method
+     * TODO Implement this org.apache.catalina.ha.ClusterMessage method
      */
     public Member getAddress() {
         return address;
@@ -63,7 +63,7 @@ public class ClusterMessageBase implements ClusterMessage {
      * setAddress
      *
      * @param member Member
-     * @todo Implement this org.apache.catalina.ha.ClusterMessage method
+     * TODO Implement this org.apache.catalina.ha.ClusterMessage method
      */
     public void setAddress(Member member) {
         this.address = member;

diff --git a/java/org/apache/catalina/ha/session/DeltaRequest.java b/java/org/apache/catalina/ha/session/DeltaRequest.java
index 1b2c9e4..9a2ec5b 100644 (file)
--- a/java/org/apache/catalina/ha/session/DeltaRequest.java
+++ b/java/org/apache/catalina/ha/session/DeltaRequest.java
@@ -278,7 +278,6 @@ public class DeltaRequest implements Externalizable {
      * serialize DeltaRequest
      * @see DeltaRequest#writeExternal(java.io.ObjectOutput)
      * 
-     * @param deltaRequest
      * @return serialized delta request
      * @throws IOException
      */

diff --git a/java/org/apache/catalina/ha/tcp/ReplicationValve.java b/java/org/apache/catalina/ha/tcp/ReplicationValve.java
index 4bbb34a..e3a8434 100644 (file)
--- a/java/org/apache/catalina/ha/tcp/ReplicationValve.java
+++ b/java/org/apache/catalina/ha/tcp/ReplicationValve.java
@@ -516,7 +516,7 @@ public class ReplicationValve
 
    /**
     * Send message delta message from request session 
-    * @param request current request
+    * @param session current session
     * @param manager session manager
     * @param cluster replication cluster
     */

diff --git a/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java b/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java
index 25df1b3..afe1d48 100644 (file)
--- a/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java
+++ b/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java
@@ -318,9 +318,9 @@ public class SimpleTcpCluster extends LifecycleBase
     }
 
     /**
-     * add cluster message listener and register cluster to this listener
+     * Add cluster message listener and register cluster to this listener.
      * 
-     * @see org.apache.catalina.ha.CatalinaCluster#addClusterListener(org.apache.catalina.ha.MessageListener)
+     * @see org.apache.catalina.ha.CatalinaCluster#addClusterListener(org.apache.catalina.ha.ClusterListener)
      */
     public void addClusterListener(ClusterListener listener) {
         if (listener != null && !clusterListeners.contains(listener)) {
@@ -330,9 +330,9 @@ public class SimpleTcpCluster extends LifecycleBase
     }
 
     /**
-     * remove message listener and deregister Cluster from listener
+     * Remove message listener and deregister Cluster from listener.
      * 
-     * @see org.apache.catalina.ha.CatalinaCluster#removeClusterListener(org.apache.catalina.ha.MessageListener)
+     * @see org.apache.catalina.ha.CatalinaCluster#removeClusterListener(org.apache.catalina.ha.ClusterListener)
      */
     public void removeClusterListener(ClusterListener listener) {
         if (listener != null) {
@@ -498,7 +498,6 @@ public class SimpleTcpCluster extends LifecycleBase
      * @param name
      *            Context Name of this manager
      * @see org.apache.catalina.Cluster#createManager(java.lang.String)
-     * @see #addManager(String, Manager)
      * @see DeltaManager#start()
      */
     public synchronized Manager createManager(String name) {
@@ -536,10 +535,11 @@ public class SimpleTcpCluster extends LifecycleBase
     }
 
     /**
-     * remove an application form cluster replication bus
+     * Remove an application from cluster replication bus.
      * 
-     * @see org.apache.catalina.ha.CatalinaCluster#removeManager(java.lang.String,Manager)
+     * @see org.apache.catalina.Cluster#removeManager(Manager)
      */
+    @Override
     public void removeManager(Manager manager) {
         if (manager != null && manager instanceof ClusterManager ) {
             ClusterManager cmgr = (ClusterManager) manager;
@@ -786,7 +786,7 @@ public class SimpleTcpCluster extends LifecycleBase
      * @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)
+     *      org.apache.catalina.tribes.Member)
      */
     public void send(ClusterMessage msg, Member dest) {
         try {
@@ -811,7 +811,7 @@ public class SimpleTcpCluster extends LifecycleBase
     /**
      * New cluster member is registered
      * 
-     * @see org.apache.catalina.ha.MembershipListener#memberAdded(org.apache.catalina.ha.Member)
+     * @see org.apache.catalina.tribes.MembershipListener#memberAdded(org.apache.catalina.tribes.Member)
      */
     public void memberAdded(Member member) {
         try {
@@ -830,7 +830,7 @@ public class SimpleTcpCluster extends LifecycleBase
     /**
      * Cluster member is gone
      * 
-     * @see org.apache.catalina.ha.MembershipListener#memberDisappeared(org.apache.catalina.ha.Member)
+     * @see org.apache.catalina.tribes.MembershipListener#memberDisappeared(org.apache.catalina.tribes.Member)
      */
     public void memberDisappeared(Member member) {
         try {