From c77bb57c10d659e52fc5804518e3df2cc66c2106 Mon Sep 17 00:00:00 2001 From: markt Date: Tue, 17 Nov 2009 22:13:30 +0000 Subject: [PATCH] Fix https://issues.apache.org/bugzilla/show_bug.cgi?id=48143 Javadoc updates. Patch provide by sebb. git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@881567 13f79535-47bb-0310-9956-ffa450edef68 --- java/javax/servlet/SessionCookieConfig.java | 3 +- .../catalina/ant/jmx/JMXAccessorCreateTask.java | 2 +- .../catalina/core/ApplicationFilterChain.java | 11 +- .../apache/catalina/core/StandardContextValve.java | 3 +- .../apache/catalina/core/StandardEngineValve.java | 3 +- .../apache/catalina/core/StandardHostValve.java | 3 +- .../apache/catalina/core/StandardWrapperValve.java | 1 - java/org/apache/catalina/ha/ClusterManager.java | 2 +- .../apache/catalina/ha/session/DeltaSession.java | 8 +- .../apache/catalina/ha/tcp/SimpleTcpCluster.java | 2 +- .../apache/catalina/manager/StatusTransformer.java | 10 +- java/org/apache/catalina/realm/CombinedRealm.java | 8 +- java/org/apache/catalina/realm/LockOutRealm.java | 8 +- java/org/apache/catalina/startup/Embedded.java | 4 +- java/org/apache/catalina/startup/WebRuleSet.java | 4 +- .../catalina/tribes/group/ChannelCoordinator.java | 3 +- .../org/apache/catalina/tribes/io/ChannelData.java | 6 +- .../apache/catalina/tribes/io/ObjectReader.java | 4 +- .../catalina/tribes/io/ReplicationStream.java | 2 +- .../org/apache/catalina/tribes/io/XByteBuffer.java | 18 +--- .../tribes/membership/McastServiceImpl.java | 4 +- .../catalina/tribes/membership/MemberImpl.java | 6 +- .../catalina/tribes/membership/Membership.java | 3 +- .../tribes/transport/bio/util/LinkObject.java | 3 +- .../catalina/tribes/transport/nio/NioReceiver.java | 2 +- .../apache/catalina/users/MemoryUserDatabase.java | 2 +- java/org/apache/catalina/valves/RemoteIpValve.java | 4 +- java/org/apache/coyote/http11/Http11Processor.java | 2 +- .../apache/jasper/compiler/ParserController.java | 2 +- .../apache/jasper/compiler/TagFileProcessor.java | 2 +- .../apache/jasper/compiler/TldLocationsCache.java | 5 - java/org/apache/naming/HandlerRef.java | 10 -- java/org/apache/naming/ServiceRef.java | 12 --- .../apache/naming/resources/BaseDirContext.java | 2 +- java/org/apache/tomcat/buildutil/Txt2Html.java | 4 +- .../tomcat/util/digester/SetPropertiesRule.java | 2 +- .../tomcat/util/digester/SetPropertyRule.java | 2 +- .../apache/tomcat/util/modeler/BaseModelMBean.java | 116 ++++++++++----------- .../tomcat/util/net/NioBlockingSelector.java | 1 - .../apache/tomcat/util/net/SSLSessionManager.java | 3 +- 40 files changed, 123 insertions(+), 169 deletions(-) diff --git a/java/javax/servlet/SessionCookieConfig.java b/java/javax/servlet/SessionCookieConfig.java index 4678e4518..80637f6f1 100644 --- a/java/javax/servlet/SessionCookieConfig.java +++ b/java/javax/servlet/SessionCookieConfig.java @@ -79,8 +79,9 @@ public interface SessionCookieConfig { public boolean isSecure(); /** + * Sets the maximum age. * - * @param maxAge + * @param MaxAge the maximum age to set * @throws IllegalStateException */ public void setMaxAge(int MaxAge); diff --git a/java/org/apache/catalina/ant/jmx/JMXAccessorCreateTask.java b/java/org/apache/catalina/ant/jmx/JMXAccessorCreateTask.java index 56e95598e..3bddc1bc6 100644 --- a/java/org/apache/catalina/ant/jmx/JMXAccessorCreateTask.java +++ b/java/org/apache/catalina/ant/jmx/JMXAccessorCreateTask.java @@ -95,7 +95,7 @@ public class JMXAccessorCreateTask extends JMXAccessorTask { } /** - * @param classLoader The classLoader to set. + * @param classLoaderName The classLoader to set. */ public void setClassLoader(String classLoaderName) { this.classLoader = classLoaderName; diff --git a/java/org/apache/catalina/core/ApplicationFilterChain.java b/java/org/apache/catalina/core/ApplicationFilterChain.java index 49da22a02..0082aada1 100644 --- a/java/org/apache/catalina/core/ApplicationFilterChain.java +++ b/java/org/apache/catalina/core/ApplicationFilterChain.java @@ -324,13 +324,10 @@ final class ApplicationFilterChain implements FilterChain, CometFilterChain { /** - * Invoke the next filter in this chain, passing the specified request - * and response. If there are no more filters in this chain, invoke - * the service() method of the servlet itself. - * - * @param request The servlet request we are processing - * @param response The servlet response we are creating - * + * Process the event, using the security manager if the option is enabled. + * + * @param event the event to process + * * @exception IOException if an input/output error occurs * @exception ServletException if a servlet exception occurs */ diff --git a/java/org/apache/catalina/core/StandardContextValve.java b/java/org/apache/catalina/core/StandardContextValve.java index 5b91e3e2f..4ddc07bb3 100644 --- a/java/org/apache/catalina/core/StandardContextValve.java +++ b/java/org/apache/catalina/core/StandardContextValve.java @@ -112,7 +112,6 @@ final class StandardContextValve * * @param request Request to be processed * @param response Response to be produced - * @param valveContext Valve context used to forward to the next Valve * * @exception IOException if an input/output error occurred * @exception ServletException if a servlet error occurred @@ -230,7 +229,7 @@ final class StandardContextValve * * @param request Request to be processed * @param response Response to be produced - * @param valveContext Valve context used to forward to the next Valve + * @param event * * @exception IOException if an input/output error occurred * @exception ServletException if a servlet error occurred diff --git a/java/org/apache/catalina/core/StandardEngineValve.java b/java/org/apache/catalina/core/StandardEngineValve.java index 320720e62..d181ca1ff 100644 --- a/java/org/apache/catalina/core/StandardEngineValve.java +++ b/java/org/apache/catalina/core/StandardEngineValve.java @@ -93,7 +93,6 @@ final class StandardEngineValve * * @param request Request to be processed * @param response Response to be produced - * @param valveContext Valve context used to forward to the next Valve * * @exception IOException if an input/output error occurred * @exception ServletException if a servlet error occurred @@ -126,7 +125,7 @@ final class StandardEngineValve * * @param request Request to be processed * @param response Response to be produced - * @param valveContext Valve context used to forward to the next Valve + * @param event the event * * @exception IOException if an input/output error occurred * @exception ServletException if a servlet error occurred diff --git a/java/org/apache/catalina/core/StandardHostValve.java b/java/org/apache/catalina/core/StandardHostValve.java index 197d7b5e8..c853705a8 100644 --- a/java/org/apache/catalina/core/StandardHostValve.java +++ b/java/org/apache/catalina/core/StandardHostValve.java @@ -105,7 +105,6 @@ final class StandardHostValve * * @param request Request to be processed * @param response Response to be produced - * @param valveContext Valve context used to forward to the next Valve * * @exception IOException if an input/output error occurred * @exception ServletException if a servlet error occurred @@ -167,7 +166,7 @@ final class StandardHostValve * * @param request Request to be processed * @param response Response to be produced - * @param valveContext Valve context used to forward to the next Valve + * @param event the event * * @exception IOException if an input/output error occurred * @exception ServletException if a servlet error occurred diff --git a/java/org/apache/catalina/core/StandardWrapperValve.java b/java/org/apache/catalina/core/StandardWrapperValve.java index d4d377cb3..542ffc1dc 100644 --- a/java/org/apache/catalina/core/StandardWrapperValve.java +++ b/java/org/apache/catalina/core/StandardWrapperValve.java @@ -86,7 +86,6 @@ final class StandardWrapperValve * * @param request Request to be processed * @param response Response to be produced - * @param valveContext Valve context used to forward to the next Valve * * @exception IOException if an input/output error occurred * @exception ServletException if a servlet error occurred diff --git a/java/org/apache/catalina/ha/ClusterManager.java b/java/org/apache/catalina/ha/ClusterManager.java index f236854d5..675a0047a 100644 --- a/java/org/apache/catalina/ha/ClusterManager.java +++ b/java/org/apache/catalina/ha/ClusterManager.java @@ -86,7 +86,7 @@ public interface ClusterManager extends Manager { public boolean doDomainReplication(); /** - * @param sendClusterDomainOnly Flag value. + * @param domainReplication Flag value. * @since 5.5.10 */ public void setDomainReplication(boolean domainReplication); diff --git a/java/org/apache/catalina/ha/session/DeltaSession.java b/java/org/apache/catalina/ha/session/DeltaSession.java index 6f9e98619..fe9b2857c 100644 --- a/java/org/apache/catalina/ha/session/DeltaSession.java +++ b/java/org/apache/catalina/ha/session/DeltaSession.java @@ -98,16 +98,16 @@ public class DeltaSession extends StandardSession implements Externalizable,Clus // ----------------------------------------------------------- Constructors + public DeltaSession() { + this(null); + } + /** * Construct a new Session associated with the specified Manager. * * @param manager * The manager with which this Session is associated */ - public DeltaSession() { - this(null); - } - public DeltaSession(Manager manager) { super(manager); this.resetDeltaRequest(); diff --git a/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java b/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java index ec74166bb..b75345de7 100644 --- a/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java +++ b/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java @@ -884,7 +884,7 @@ public class SimpleTcpCluster * notify all listeners from receiving a new message is not ClusterMessage * emit Failure Event to LifecylceListener * - * @param message + * @param msg * received Message */ public boolean accept(Serializable msg, Member sender) { diff --git a/java/org/apache/catalina/manager/StatusTransformer.java b/java/org/apache/catalina/manager/StatusTransformer.java index 9adf56a49..2657ee34a 100644 --- a/java/org/apache/catalina/manager/StatusTransformer.java +++ b/java/org/apache/catalina/manager/StatusTransformer.java @@ -18,7 +18,6 @@ package org.apache.catalina.manager; -import java.io.IOException; import java.io.PrintWriter; import java.lang.reflect.Method; import java.text.MessageFormat; @@ -31,7 +30,6 @@ import java.util.Vector; import javax.management.MBeanServer; import javax.management.ObjectInstance; import javax.management.ObjectName; -import javax.servlet.ServletException; import javax.servlet.http.HttpServletResponse; import org.apache.catalina.util.RequestUtil; @@ -62,13 +60,11 @@ public class StatusTransformer { /** - * Process a GET request for the specified resource. + * Write an HTML or XML header. * - * @param request The servlet request we are processing - * @param response The servlet response we are creating + * @param writer the PrintWriter to use + * @param mode - 0 = HTML header, 1 = XML declaration * - * @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){ diff --git a/java/org/apache/catalina/realm/CombinedRealm.java b/java/org/apache/catalina/realm/CombinedRealm.java index 6b1c4392c..9b5065b21 100644 --- a/java/org/apache/catalina/realm/CombinedRealm.java +++ b/java/org/apache/catalina/realm/CombinedRealm.java @@ -125,15 +125,15 @@ public class CombinedRealm extends RealmBase { * * @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 nonce Unique (or supposedly unique) token which has been used * for this request - * @param realm Realm name + * @param realmName Realm name * @param md5a2 Second MD5 digest used to calculate the digest : * MD5(Method + ":" + uri) */ @Override public Principal authenticate(String username, String clientDigest, - String once, String nc, String cnonce, String qop, + String nonce, String nc, String cnonce, String qop, String realmName, String md5a2) { Principal authenticatedUser = null; @@ -142,7 +142,7 @@ public class CombinedRealm extends RealmBase { log.debug(sm.getString("combinedRealm.authStart", username, realm.getInfo())); } - authenticatedUser = realm.authenticate(username, clientDigest, once, + authenticatedUser = realm.authenticate(username, clientDigest, nonce, nc, cnonce, qop, realmName, md5a2); if (authenticatedUser == null) { diff --git a/java/org/apache/catalina/realm/LockOutRealm.java b/java/org/apache/catalina/realm/LockOutRealm.java index e0d925d41..744ba96c6 100644 --- a/java/org/apache/catalina/realm/LockOutRealm.java +++ b/java/org/apache/catalina/realm/LockOutRealm.java @@ -149,15 +149,15 @@ public class LockOutRealm extends CombinedRealm { * * @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 nonce Unique (or supposedly unique) token which has been used * for this request - * @param realm Realm name + * @param realmName Realm name * @param md5a2 Second MD5 digest used to calculate the digest : * MD5(Method + ":" + uri) */ @Override public Principal authenticate(String username, String clientDigest, - String once, String nc, String cnonce, String qop, + String nonce, String nc, String cnonce, String qop, String realmName, String md5a2) { if (isLocked(username)) { @@ -169,7 +169,7 @@ public class LockOutRealm extends CombinedRealm { } Principal authenticatedUser = super.authenticate(username, clientDigest, - once, nc, cnonce, qop, realmName, md5a2); + nonce, nc, cnonce, qop, realmName, md5a2); if (authenticatedUser == null) { registerAuthFailure(username); diff --git a/java/org/apache/catalina/startup/Embedded.java b/java/org/apache/catalina/startup/Embedded.java index 8274a9a12..3b857bbd9 100644 --- a/java/org/apache/catalina/startup/Embedded.java +++ b/java/org/apache/catalina/startup/Embedded.java @@ -237,9 +237,9 @@ public class Embedded extends StandardService { /** - * Enables or disables naming support. + * Enables or disables redirection. * - * @param useNaming The new use naming value + * @param redirectStreams The new redirection value */ public void setRedirectStreams(boolean redirectStreams) { diff --git a/java/org/apache/catalina/startup/WebRuleSet.java b/java/org/apache/catalina/startup/WebRuleSet.java index 05f4aa406..7c57131a9 100644 --- a/java/org/apache/catalina/startup/WebRuleSet.java +++ b/java/org/apache/catalina/startup/WebRuleSet.java @@ -1013,7 +1013,7 @@ final class SoapHeaderRule extends Rule { * no namespace * @param name the local name if the parser is namespace aware, or just * the element name otherwise - * @param bodyText The body text of this element + * @param text The body text of this element */ @Override public void body(String namespace, String name, String text) @@ -1048,7 +1048,7 @@ final class ServiceQnameRule extends Rule { * no namespace * @param name the local name if the parser is namespace aware, or just * the element name otherwise - * @param bodyText The body text of this element + * @param text The body text of this element */ @Override public void body(String namespace, String name, String text) diff --git a/java/org/apache/catalina/tribes/group/ChannelCoordinator.java b/java/org/apache/catalina/tribes/group/ChannelCoordinator.java index 5da083e62..6e7e6748c 100644 --- a/java/org/apache/catalina/tribes/group/ChannelCoordinator.java +++ b/java/org/apache/catalina/tribes/group/ChannelCoordinator.java @@ -72,8 +72,7 @@ public class ChannelCoordinator extends ChannelInterceptorBase implements Messag * Send a message to one or more members in the cluster * @param destination Member[] - the destinations, null or zero length means all * @param msg ClusterMessage - the message to send - * @param options int - sender options, see class documentation - * @return ClusterMessage[] - the replies from the members, if any. + * @param payload TBA */ @Override public void sendMessage(Member[] destination, ChannelMessage msg, InterceptorPayload payload) throws ChannelException { diff --git a/java/org/apache/catalina/tribes/io/ChannelData.java b/java/org/apache/catalina/tribes/io/ChannelData.java index 209983026..8266cfb1c 100644 --- a/java/org/apache/catalina/tribes/io/ChannelData.java +++ b/java/org/apache/catalina/tribes/io/ChannelData.java @@ -136,7 +136,9 @@ public class ChannelData implements ChannelMessage { return options; } /** - * @param sets the message options + * Sets the message options. + * + * @param options the message options */ public void setOptions(int options) { this.options = options; @@ -215,7 +217,7 @@ public class ChannelData implements ChannelMessage { /** * Deserializes a ChannelData object from a byte array - * @param b byte[] + * @param xbuf byte[] * @return ChannelData */ public static ChannelData getDataFromPackage(XByteBuffer xbuf) { diff --git a/java/org/apache/catalina/tribes/io/ObjectReader.java b/java/org/apache/catalina/tribes/io/ObjectReader.java index 86505bf71..2ced30a23 100644 --- a/java/org/apache/catalina/tribes/io/ObjectReader.java +++ b/java/org/apache/catalina/tribes/io/ObjectReader.java @@ -89,9 +89,9 @@ public class ObjectReader { * Append new bytes to buffer. * @see XByteBuffer#countPackages() * @param data new transfer buffer - * @param off offset * @param len length in buffer - * @return number of messages that was sent to callback + * @param count whether to return the count + * @return number of messages that was sent to callback (or -1 if count == false) * @throws java.io.IOException */ public int append(ByteBuffer data, int len, boolean count) throws java.io.IOException { diff --git a/java/org/apache/catalina/tribes/io/ReplicationStream.java b/java/org/apache/catalina/tribes/io/ReplicationStream.java index cf6e05643..14a57cde9 100644 --- a/java/org/apache/catalina/tribes/io/ReplicationStream.java +++ b/java/org/apache/catalina/tribes/io/ReplicationStream.java @@ -48,7 +48,7 @@ public final class ReplicationStream extends ObjectInputStream { * Construct a new instance of CustomObjectInputStream * * @param stream The input stream we will read from - * @param classLoader The class loader used to instantiate objects + * @param classLoaders The class loader array used to instantiate objects * * @exception IOException if an input/output error occurs */ diff --git a/java/org/apache/catalina/tribes/io/XByteBuffer.java b/java/org/apache/catalina/tribes/io/XByteBuffer.java index fe2963276..6cf853cd9 100644 --- a/java/org/apache/catalina/tribes/io/XByteBuffer.java +++ b/java/org/apache/catalina/tribes/io/XByteBuffer.java @@ -145,7 +145,6 @@ public class XByteBuffer * Appends the data to the buffer. If the data is incorrectly formatted, ie, the data should always start with the * header, false will be returned and the data will be discarded. * @param b - bytes to be appended - * @param off - the offset to extract data from * @param len - the number of bytes to append. * @return true if the data was appended correctly. Returns false if the package is incorrect, ie missing header or something, or the length of data is 0 */ @@ -330,8 +329,7 @@ public class XByteBuffer /** * Creates a complete data package - * @param indata - the message data to be contained within the package - * @param compressed - compression flag for the indata buffer + * @param cdata - the message data to be contained within the package * @return - a full package (header,size,data,footer) * */ @@ -423,9 +421,9 @@ public class XByteBuffer /** - * Converts an integer to four bytes - * @param n - the integer - * @return - four bytes in an array + * Converts a boolean to a 1-byte array + * @param bool - the integer + * @return - 1-byte array * @deprecated use toBytes(boolean,byte[],int) */ @Deprecated @@ -440,11 +438,6 @@ public class XByteBuffer return data; } - /** - * - * @param long - * @return use - */ public static boolean toBoolean(byte[] b, int offset) { return b[offset] != 0; } @@ -582,8 +575,7 @@ public class XByteBuffer /** * Serializes a message into cluster data * @param msg ClusterMessage - * @param compress boolean - * @return + * @return serialized content as byte[] array * @throws IOException */ public static byte[] serialize(Serializable msg) throws IOException { diff --git a/java/org/apache/catalina/tribes/membership/McastServiceImpl.java b/java/org/apache/catalina/tribes/membership/McastServiceImpl.java index 7df5f1efb..437985413 100644 --- a/java/org/apache/catalina/tribes/membership/McastServiceImpl.java +++ b/java/org/apache/catalina/tribes/membership/McastServiceImpl.java @@ -160,7 +160,7 @@ public class McastServiceImpl * @param bind - the bind address (not sure this is used yet) * @param mcastAddress - the mcast address * @param service - the callback service - * @param disableLoopbackMode - disable loopbackMode + * @param localLoopbackDisabled - disable loopbackMode * @throws IOException */ public McastServiceImpl( @@ -465,7 +465,7 @@ public class McastServiceImpl /** * Send a ping - * @throws Exception + * @throws IOException */ public void send(boolean checkexpired) throws IOException{ send(checkexpired,null); diff --git a/java/org/apache/catalina/tribes/membership/MemberImpl.java b/java/org/apache/catalina/tribes/membership/MemberImpl.java index 577b5b4e2..80ced1a2d 100644 --- a/java/org/apache/catalina/tribes/membership/MemberImpl.java +++ b/java/org/apache/catalina/tribes/membership/MemberImpl.java @@ -75,7 +75,7 @@ public class MemberImpl implements Member, java.io.Externalizable { */ protected int msgCount = 0; /** - * The number of milliseconds since this members was + * The number of milliseconds since this member was * created, is kept track of using the start time */ protected long memberAliveTime = 0; @@ -122,10 +122,9 @@ public class MemberImpl implements Member, java.io.Externalizable { /** * Construct a new member object - * @param name - the name of this member, cluster unique - * @param domain - the cluster domain name of this member * @param host - the tcp listen host * @param port - the tcp listen port + * @param aliveTime - the number of milliseconds since this member was created */ public MemberImpl(String host, int port, @@ -164,7 +163,6 @@ public class MemberImpl implements Member, java.io.Externalizable { * Create a data package to send over the wire representing this member. * This is faster than serialization. * @return - the bytes for this member deserialized - * @throws Exception */ public byte[] getData() { return getData(true); diff --git a/java/org/apache/catalina/tribes/membership/Membership.java b/java/org/apache/catalina/tribes/membership/Membership.java index db547d7d1..b9d6eeff3 100644 --- a/java/org/apache/catalina/tribes/membership/Membership.java +++ b/java/org/apache/catalina/tribes/membership/Membership.java @@ -77,7 +77,8 @@ public class Membership /** * Constructs a new membership - * @param name - has to be the name of the local member. Used to filter the local member from the cluster membership + * @param local - has to be the name of the local member. Used to filter the local member from the cluster membership + * @param includeLocal - TBA */ public Membership(MemberImpl local, boolean includeLocal) { this.local = local; diff --git a/java/org/apache/catalina/tribes/transport/bio/util/LinkObject.java b/java/org/apache/catalina/tribes/transport/bio/util/LinkObject.java index a21c1f14c..8bea3d186 100644 --- a/java/org/apache/catalina/tribes/transport/bio/util/LinkObject.java +++ b/java/org/apache/catalina/tribes/transport/bio/util/LinkObject.java @@ -46,7 +46,8 @@ public class LinkObject { * Construct a new element from the data object. * Sets the pointer to null. * - * @param key The key + * @param msg the message + * @param destination TBA * @param payload The data object. */ public LinkObject(ChannelMessage msg, Member[] destination, InterceptorPayload payload) { diff --git a/java/org/apache/catalina/tribes/transport/nio/NioReceiver.java b/java/org/apache/catalina/tribes/transport/nio/NioReceiver.java index 6866e85cc..9ab899d58 100644 --- a/java/org/apache/catalina/tribes/transport/nio/NioReceiver.java +++ b/java/org/apache/catalina/tribes/transport/nio/NioReceiver.java @@ -89,7 +89,7 @@ public class NioReceiver extends ReceiverBase implements Runnable, ChannelReceiv /** * start cluster receiver - * @throws Exception + * @throws IOException * @see org.apache.catalina.tribes.ClusterReceiver#start() */ @Override diff --git a/java/org/apache/catalina/users/MemoryUserDatabase.java b/java/org/apache/catalina/users/MemoryUserDatabase.java index 1b3e2840f..080b0af13 100644 --- a/java/org/apache/catalina/users/MemoryUserDatabase.java +++ b/java/org/apache/catalina/users/MemoryUserDatabase.java @@ -205,7 +205,7 @@ public class MemoryUserDatabase implements UserDatabase { /** * Setting the readonly status of the user database * - * @param pathname The new pathname + * @param readonly the new status */ public void setReadonly(boolean readonly) { diff --git a/java/org/apache/catalina/valves/RemoteIpValve.java b/java/org/apache/catalina/valves/RemoteIpValve.java index af462c8d4..226e3f802 100644 --- a/java/org/apache/catalina/valves/RemoteIpValve.java +++ b/java/org/apache/catalina/valves/RemoteIpValve.java @@ -691,7 +691,7 @@ public class RemoteIpValve extends ValveBase { * Default value : X-Forwarded-For *

* - * @param remoteIPHeader + * @param remoteIpHeader */ public void setRemoteIpHeader(String remoteIpHeader) { this.remoteIpHeader = remoteIpHeader; @@ -699,7 +699,7 @@ public class RemoteIpValve extends ValveBase { /** *

- * Comma delimited list of proxies that are trusted when they appear in the {@link #remoteIPHeader} header. Can be expressed as a + * Comma delimited list of proxies that are trusted when they appear in the {@link #remoteIpHeader} header. Can be expressed as a * regular expression. *

*

diff --git a/java/org/apache/coyote/http11/Http11Processor.java b/java/org/apache/coyote/http11/Http11Processor.java index 71705304b..6d07e458e 100644 --- a/java/org/apache/coyote/http11/Http11Processor.java +++ b/java/org/apache/coyote/http11/Http11Processor.java @@ -139,7 +139,7 @@ public class Http11Processor extends AbstractHttp11Processor implements ActionHo /** * Process pipelined HTTP requests on the specified socket. * - * @param socket Socket from which the HTTP requests will be read + * @param socketWrapper Socket from which the HTTP requests will be read * and the HTTP responses will be written. * * @throws IOException error during an I/O operation diff --git a/java/org/apache/jasper/compiler/ParserController.java b/java/org/apache/jasper/compiler/ParserController.java index d7f49d034..654904bba 100644 --- a/java/org/apache/jasper/compiler/ParserController.java +++ b/java/org/apache/jasper/compiler/ParserController.java @@ -126,7 +126,7 @@ class ParserController implements TagConstants { * * @param inFileName The path to the resource to be included. * @param parent The parent node of the include directive. - * @param jarFile The JAR file from which to read the included resource, + * @param jarFileUrl The JAR file from which to read the included resource, * or null of the included resource is to be read from the filesystem */ public Node.Nodes parse(String inFileName, Node parent, diff --git a/java/org/apache/jasper/compiler/TagFileProcessor.java b/java/org/apache/jasper/compiler/TagFileProcessor.java index e1fd86c56..7bb00c72c 100644 --- a/java/org/apache/jasper/compiler/TagFileProcessor.java +++ b/java/org/apache/jasper/compiler/TagFileProcessor.java @@ -502,7 +502,7 @@ class TagFileProcessor { * the current ParserController used in this compilation * @param name * the tag name as specified in the TLD - * @param tagfile + * @param path * the path for the tagfile * @param tagFileJarUrl * the url for the Jar containign the tag file diff --git a/java/org/apache/jasper/compiler/TldLocationsCache.java b/java/org/apache/jasper/compiler/TldLocationsCache.java index 226892dce..dc9171dea 100644 --- a/java/org/apache/jasper/compiler/TldLocationsCache.java +++ b/java/org/apache/jasper/compiler/TldLocationsCache.java @@ -185,11 +185,6 @@ public class TldLocationsCache { * * @param ctxt the servlet context of the web application in which Jasper * is running - * @param redeployMode if true, then the compiler will allow redeploying - * a tag library from the same jar, at the expense of slowing down the - * server a bit. Note that this may only work on JDK 1.3.1_01a and later, - * because of JDK bug 4211817 fixed in this release. - * If redeployMode is false, a faster but less capable mode will be used. */ public TldLocationsCache(ServletContext ctxt) { this.ctxt = ctxt; diff --git a/java/org/apache/naming/HandlerRef.java b/java/org/apache/naming/HandlerRef.java index a2cd1fcaf..07e0be7c4 100644 --- a/java/org/apache/naming/HandlerRef.java +++ b/java/org/apache/naming/HandlerRef.java @@ -96,21 +96,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); diff --git a/java/org/apache/naming/ServiceRef.java b/java/org/apache/naming/ServiceRef.java index 8269a84b8..aa061652b 100644 --- a/java/org/apache/naming/ServiceRef.java +++ b/java/org/apache/naming/ServiceRef.java @@ -91,24 +91,12 @@ 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, null, null); } - - /** - * Service Reference. - * - * @param serviceClass Service class - */ public ServiceRef(String refname, String serviceInterface, String[] serviceQname, String wsdl, String jaxrpcmapping, String factory, String factoryLocation) { diff --git a/java/org/apache/naming/resources/BaseDirContext.java b/java/org/apache/naming/resources/BaseDirContext.java index 0cf6509c3..f96418ff2 100644 --- a/java/org/apache/naming/resources/BaseDirContext.java +++ b/java/org/apache/naming/resources/BaseDirContext.java @@ -341,7 +341,7 @@ public abstract class BaseDirContext implements DirContext { * Return the real path for a given virtual path, if possible; otherwise * return null. * - * @param path The path to the desired resource + * @param name The path to the desired resource */ public String getRealPath(String name) { if (!aliases.isEmpty()) { diff --git a/java/org/apache/tomcat/buildutil/Txt2Html.java b/java/org/apache/tomcat/buildutil/Txt2Html.java index 8110686ff..0765fc390 100644 --- a/java/org/apache/tomcat/buildutil/Txt2Html.java +++ b/java/org/apache/tomcat/buildutil/Txt2Html.java @@ -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,7 +72,7 @@ public class Txt2Html /** * Perform the conversion * - * @param BuildException Thrown if an error occurs during execution of + * @throws BuildException if an error occurs during execution of * this task. */ @Override diff --git a/java/org/apache/tomcat/util/digester/SetPropertiesRule.java b/java/org/apache/tomcat/util/digester/SetPropertiesRule.java index 941808122..a535df657 100644 --- a/java/org/apache/tomcat/util/digester/SetPropertiesRule.java +++ b/java/org/apache/tomcat/util/digester/SetPropertiesRule.java @@ -154,7 +154,7 @@ public class SetPropertiesRule extends Rule { * @param namespace the namespace URI of the matching element, or an * empty string if the parser is not namespace aware or the element has * no namespace - * @param name the local name if the parser is namespace aware, or just + * @param theName the local name if the parser is namespace aware, or just * the element name otherwise * @param attributes The attribute list for this element */ diff --git a/java/org/apache/tomcat/util/digester/SetPropertyRule.java b/java/org/apache/tomcat/util/digester/SetPropertyRule.java index 2ae8f7bf1..5bb9b7f2e 100644 --- a/java/org/apache/tomcat/util/digester/SetPropertyRule.java +++ b/java/org/apache/tomcat/util/digester/SetPropertyRule.java @@ -95,7 +95,7 @@ public class SetPropertyRule extends Rule { * @param namespace the namespace URI of the matching element, or an * empty string if the parser is not namespace aware or the element has * no namespace - * @param name the local name if the parser is namespace aware, or just + * @param theName the local name if the parser is namespace aware, or just * the element name otherwise * @param attributes The attribute list for this element * diff --git a/java/org/apache/tomcat/util/modeler/BaseModelMBean.java b/java/org/apache/tomcat/util/modeler/BaseModelMBean.java index de6b81073..4cecf75aa 100644 --- a/java/org/apache/tomcat/util/modeler/BaseModelMBean.java +++ b/java/org/apache/tomcat/util/modeler/BaseModelMBean.java @@ -926,23 +926,23 @@ public class BaseModelMBean implements DynamicMBean, MBeanRegistration, ModelMBe // ------------------------------------------------ PersistentMBean Methods - /** - * Instantiates this MBean instance from data found in the persistent - * store. The data loaded could include attribute and operation values. - * This method should be called during construction or initialization - * of the instance, and before the MBean is registered with the - * MBeanServer. - * - *

IMPLEMENTATION NOTE - This implementation does - * not support persistence.

- * - * @exception InstanceNotFoundException if the managed resource object - * cannot be found - * @exception MBeanException if the initializer of the object throws - * an exception - * @exception RuntimeOperationsException if an exception is reported - * by the persistence mechanism - */ +// /** +// * Instantiates this MBean instance from data found in the persistent +// * store. The data loaded could include attribute and operation values. +// * This method should be called during construction or initialization +// * of the instance, and before the MBean is registered with the +// * MBeanServer. +// * +// *

IMPLEMENTATION NOTE - This implementation does +// * not support persistence.

+// * +// * @exception InstanceNotFoundException if the managed resource object +// * cannot be found +// * @exception MBeanException if the initializer of the object throws +// * an exception +// * @exception RuntimeOperationsException if an exception is reported +// * by the persistence mechanism +// */ // public void load() throws InstanceNotFoundException, // MBeanException, RuntimeOperationsException { // // XXX If a context was set, use it to load the data @@ -953,22 +953,22 @@ public class BaseModelMBean implements DynamicMBean, MBeanRegistration, ModelMBe // } - /** - * Capture the current state of this MBean instance and write it out - * to the persistent store. The state stored could include attribute - * and operation values. If one of these methods of persistence is not - * supported, a "service not found" exception will be thrown. - * - *

IMPLEMENTATION NOTE - This implementation does - * not support persistence.

- * - * @exception InstanceNotFoundException if the managed resource object - * cannot be found - * @exception MBeanException if the initializer of the object throws - * an exception, or persistence is not supported - * @exception RuntimeOperationsException if an exception is reported - * by the persistence mechanism - */ +// /** +// * Capture the current state of this MBean instance and write it out +// * to the persistent store. The state stored could include attribute +// * and operation values. If one of these methods of persistence is not +// * supported, a "service not found" exception will be thrown. +// * +// *

IMPLEMENTATION NOTE - This implementation does +// * not support persistence.

+// * +// * @exception InstanceNotFoundException if the managed resource object +// * cannot be found +// * @exception MBeanException if the initializer of the object throws +// * an exception, or persistence is not supported +// * @exception RuntimeOperationsException if an exception is reported +// * by the persistence mechanism +// */ // public void store() throws InstanceNotFoundException, // MBeanException, RuntimeOperationsException { // @@ -981,20 +981,20 @@ public class BaseModelMBean implements DynamicMBean, MBeanRegistration, ModelMBe // -------------------- BaseModelMBean methods -------------------- - /** Set the type of the mbean. This is used as a key to locate - * the description in the Registry. - * - * @param type the type of classname of the modeled object - */ +// /** Set the type of the mbean. This is used as a key to locate +// * the description in the Registry. +// * +// * @param type the type of classname of the modeled object +// */ // void setModeledType( String type ) { // initModelInfo(type); // createResource(); // } - /** Set the type of the mbean. This is used as a key to locate - * the description in the Registry. - * - * @param type the type of classname of the modeled object - */ +// /** Set the type of the mbean. This is used as a key to locate +// * the description in the Registry. +// * +// * @param type the type of classname of the modeled object +// */ // void initModelInfo( String type ) { // try { // if( log.isDebugEnabled()) @@ -1024,9 +1024,9 @@ public class BaseModelMBean implements DynamicMBean, MBeanRegistration, ModelMBe // } // } - /** Set the type of the mbean. This is used as a key to locate - * the description in the Registry. - */ +// /** Set the type of the mbean. This is used as a key to locate +// * the description in the Registry. +// */ // protected void createResource() { // try { // //Thread.currentThread().setContextClassLoader(BaseModelMBean.class.getClassLoader()); @@ -1079,9 +1079,9 @@ public class BaseModelMBean implements DynamicMBean, MBeanRegistration, ModelMBe // ------------------------------------------------------ Protected Methods - /** - * Create and return a default ModelMBeanInfo object. - */ +// /** +// * Create and return a default ModelMBeanInfo object. +// */ // protected ModelMBeanInfo createDefaultModelMBeanInfo() { // // return (new ModelMBeanInfoSupport(this.getClass().getName(), @@ -1090,15 +1090,15 @@ public class BaseModelMBean implements DynamicMBean, MBeanRegistration, ModelMBe // // } - /** - * Is the specified ModelMBeanInfo instance valid? - * - *

IMPLEMENTATION NOTE - This implementation - * does not check anything, but this method can be overridden - * as required.

- * - * @param info The ModelMBeanInfo object to check - */ +// /** +// * Is the specified ModelMBeanInfo instance valid? +// * +// *

IMPLEMENTATION NOTE - This implementation +// * does not check anything, but this method can be overridden +// * as required.

+// * +// * @param info The ModelMBeanInfo object to check +// */ // protected boolean isModelMBeanInfoValid(ModelMBeanInfo info) { // return (true); // } diff --git a/java/org/apache/tomcat/util/net/NioBlockingSelector.java b/java/org/apache/tomcat/util/net/NioBlockingSelector.java index eb134465b..cbcda4677 100644 --- a/java/org/apache/tomcat/util/net/NioBlockingSelector.java +++ b/java/org/apache/tomcat/util/net/NioBlockingSelector.java @@ -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 diff --git a/java/org/apache/tomcat/util/net/SSLSessionManager.java b/java/org/apache/tomcat/util/net/SSLSessionManager.java index 026931104..fe9310904 100644 --- a/java/org/apache/tomcat/util/net/SSLSessionManager.java +++ b/java/org/apache/tomcat/util/net/SSLSessionManager.java @@ -25,8 +25,7 @@ package org.apache.tomcat.util.net; */ public interface SSLSessionManager { /** - * Invalidate the specified SSL session - * @param sessionId The ID of the session to invalidate. + * Invalidate the SSL session */ public void invalidateSession(); } -- 2.11.0