Author: markt
Date: Mon Aug 2 17:05:03 2010
New Revision: 981602
URL: http://svn.apache.org/viewvc?rev=981602&view=rev
Log:
Handful of Javadoc fixes
Modified:
tomcat/trunk/java/org/apache/catalina/core/ApplicationContext.java
tomcat/trunk/java/org/apache/catalina/core/StandardServer.java
tomcat/trunk/java/org/apache/catalina/filters/ExpiresFilter.java
tomcat/trunk/java/org/apache/catalina/ha/ClusterMessageBase.java
tomcat/trunk/java/org/apache/catalina/ha/session/DeltaRequest.java
tomcat/trunk/java/org/apache/catalina/ha/tcp/ReplicationValve.java
tomcat/trunk/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java
Modified: tomcat/trunk/java/org/apache/catalina/core/ApplicationContext.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/core/ApplicationContext.java?rev=981602&r1=981601&r2=981602&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/core/ApplicationContext.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/core/ApplicationContext.java Mon Aug
2 17:05:03 2010
@@ -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)}
Modified: tomcat/trunk/java/org/apache/catalina/core/StandardServer.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/core/StandardServer.java?rev=981602&r1=981601&r2=981602&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/core/StandardServer.java (original)
+++ tomcat/trunk/java/org/apache/catalina/core/StandardServer.java Mon Aug 2
17:05:03 2010
@@ -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;
Modified: tomcat/trunk/java/org/apache/catalina/filters/ExpiresFilter.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/filters/ExpiresFilter.java?rev=981602&r1=981601&r2=981602&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/filters/ExpiresFilter.java (original)
+++ tomcat/trunk/java/org/apache/catalina/filters/ExpiresFilter.java Mon Aug 2
17:05:03 2010
@@ -354,7 +354,7 @@ import org.apache.juli.logging.LogFactor
* {...@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 Filte
* </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).
Modified: tomcat/trunk/java/org/apache/catalina/ha/ClusterMessageBase.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/ha/ClusterMessageBase.java?rev=981602&r1=981601&r2=981602&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/ha/ClusterMessageBase.java (original)
+++ tomcat/trunk/java/org/apache/catalina/ha/ClusterMessageBase.java Mon Aug 2
17:05:03 2010
@@ -45,7 +45,7 @@ public class ClusterMessageBase implemen
* 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 implemen
* 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;
Modified: tomcat/trunk/java/org/apache/catalina/ha/session/DeltaRequest.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/ha/session/DeltaRequest.java?rev=981602&r1=981601&r2=981602&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/ha/session/DeltaRequest.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/ha/session/DeltaRequest.java Mon Aug
2 17:05:03 2010
@@ -278,7 +278,6 @@ public class DeltaRequest implements Ext
* serialize DeltaRequest
* @see DeltaRequest#writeExternal(java.io.ObjectOutput)
*
- * @param deltaRequest
* @return serialized delta request
* @throws IOException
*/
Modified: tomcat/trunk/java/org/apache/catalina/ha/tcp/ReplicationValve.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/ha/tcp/ReplicationValve.java?rev=981602&r1=981601&r2=981602&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/ha/tcp/ReplicationValve.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/ha/tcp/ReplicationValve.java Mon Aug
2 17:05:03 2010
@@ -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
*/
Modified: tomcat/trunk/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java?rev=981602&r1=981601&r2=981602&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java Mon Aug
2 17:05:03 2010
@@ -318,9 +318,9 @@ public class SimpleTcpCluster extends Li
}
/**
- * 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 Li
}
/**
- * 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 Li
* @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 Li
}
/**
- * 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 Li
* @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 Li
/**
* 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 Li
/**
* 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 {
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
