Author: markt
Date: Wed Apr 14 22:27:59 2010
New Revision: 934224
URL: http://svn.apache.org/viewvc?rev=934224&view=rev
Log:
Fix https://issues.apache.org/bugzilla/show_bug.cgi?id=49105
Misc Javadoc corrections.
Modified:
tomcat/trunk/java/javax/el/ExpressionFactory.java
tomcat/trunk/java/javax/servlet/HttpConstraintElement.java
tomcat/trunk/java/javax/servlet/ServletContext.java
tomcat/trunk/java/org/apache/catalina/Context.java
tomcat/trunk/java/org/apache/catalina/Host.java
tomcat/trunk/java/org/apache/catalina/Lifecycle.java
tomcat/trunk/java/org/apache/catalina/Session.java
tomcat/trunk/java/org/apache/catalina/authenticator/FormAuthenticator.java
tomcat/trunk/java/org/apache/catalina/connector/Request.java
tomcat/trunk/java/org/apache/catalina/core/ApplicationSessionCookieConfig.java
tomcat/trunk/java/org/apache/catalina/core/ContainerBase.java
tomcat/trunk/java/org/apache/catalina/core/StandardContext.java
tomcat/trunk/java/org/apache/catalina/session/StandardSession.java
tomcat/trunk/java/org/apache/catalina/tribes/ChannelListener.java
tomcat/trunk/java/org/apache/catalina/tribes/group/RpcChannel.java
tomcat/trunk/java/org/apache/el/parser/AstValue.java
tomcat/trunk/java/org/apache/jasper/compiler/Node.java
tomcat/trunk/webapps/examples/WEB-INF/classes/chat/ChatServlet.java
tomcat/trunk/webapps/examples/WEB-INF/classes/filters/ExampleFilter.java
tomcat/trunk/webapps/examples/WEB-INF/classes/filters/SetCharacterEncodingFilter.java
Modified: tomcat/trunk/java/javax/el/ExpressionFactory.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/el/ExpressionFactory.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/java/javax/el/ExpressionFactory.java (original)
+++ tomcat/trunk/java/javax/el/ExpressionFactory.java Wed Apr 14 22:27:59 2010
@@ -101,7 +101,7 @@ public abstract class ExpressionFactory
* <li>Platform default implementation -
* org.apache.el.ExpressionFactoryImpl</li>
* </ol>
- * @return
+ * @return the new ExpressionFactory
*/
public static ExpressionFactory newInstance() {
return newInstance(null);
@@ -111,8 +111,8 @@ public abstract class ExpressionFactory
* Create a new {...@link ExpressionFactory} passing in the provided
* {...@link Properties}. Search order is the same as {...@link
#newInstance()}.
*
- * @param properties
- * @return
+ * @param properties the properties to be passed to the new instance (may
be null)
+ * @return the new ExpressionFactory
*/
public static ExpressionFactory newInstance(Properties properties) {
String className = null;
Modified: tomcat/trunk/java/javax/servlet/HttpConstraintElement.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/HttpConstraintElement.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/HttpConstraintElement.java (original)
+++ tomcat/trunk/java/javax/servlet/HttpConstraintElement.java Wed Apr 14
22:27:59 2010
@@ -43,7 +43,7 @@ public class HttpConstraintElement {
}
/**
- * Convenience constructor for {...@link EmptyRoleSemantic.DENY}.
+ * Convenience constructor for {...@link EmptyRoleSemantic#DENY}.
*
*/
public HttpConstraintElement(EmptyRoleSemantic emptyRoleSemantic) {
Modified: tomcat/trunk/java/javax/servlet/ServletContext.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletContext.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletContext.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletContext.java Wed Apr 14 22:27:59 2010
@@ -843,7 +843,7 @@ public interface ServletContext {
*
* @param sessionTrackingModes
* @throws IllegalArgumentException If sessionTrackingModes specifies
- * {...@link SessionTrackingMode.SSL} in
+ * {...@link SessionTrackingMode#SSL} in
* combination with any other
* {...@link SessionTrackingMode}
* @throws IllegalStateException If the context has already been
Modified: tomcat/trunk/java/org/apache/catalina/Context.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Context.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Context.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Context.java Wed Apr 14 22:27:59 2010
@@ -738,7 +738,7 @@ public interface Context extends Contain
*
* @param pattern URL pattern to be mapped
* @param name Name of the corresponding servlet to execute
- * @param jspWildCard true if name identifies the JspServlet
+ * @param jspWildcard true if name identifies the JspServlet
* and pattern contains a wildcard; false otherwise
*/
public void addServletMapping(String pattern, String name,
Modified: tomcat/trunk/java/org/apache/catalina/Host.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Host.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Host.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Host.java Wed Apr 14 22:27:59 2010
@@ -235,7 +235,7 @@ public interface Host extends Container
/**
* Returns true if the Host will attempt to create directories for appBase
and xmlBase
* unless they already exist.
- * @return
+ * @return true if the Host will attempt to create directories
*/
public boolean getCreateDirs();
/**
Modified: tomcat/trunk/java/org/apache/catalina/Lifecycle.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Lifecycle.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Lifecycle.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Lifecycle.java Wed Apr 14 22:27:59
2010
@@ -60,7 +60,7 @@ package org.apache.catalina;
* try to stop all sub-components - even those it didn't start.
*
* MUST_STOP is used to indicate that the {...@link #stop()} should be called
on
- * the component as soon as {...@link start()} exits.
+ * the component as soon as {...@link #start()} exits.
*
* Attempting any other transition will throw {...@link LifecycleException}.
*
Modified: tomcat/trunk/java/org/apache/catalina/Session.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Session.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Session.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Session.java Wed Apr 14 22:27:59 2010
@@ -137,7 +137,7 @@ public interface Session {
/**
* Return the last client access time without invalidation check
- * @see #getThisAccessedTime().
+ * @see #getThisAccessedTime()
*/
public long getThisAccessedTimeInternal();
@@ -152,7 +152,7 @@ public interface Session {
/**
* Return the last client access time without invalidation check
- * @see #getLastAccessedTime().
+ * @see #getLastAccessedTime()
*/
public long getLastAccessedTimeInternal();
Modified:
tomcat/trunk/java/org/apache/catalina/authenticator/FormAuthenticator.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/authenticator/FormAuthenticator.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/authenticator/FormAuthenticator.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/authenticator/FormAuthenticator.java
Wed Apr 14 22:27:59 2010
@@ -309,7 +309,7 @@ public class FormAuthenticator
* @param config Login configuration describing how authentication
* should be performed
* @throws IOException If the forward to the login page fails and the call
- * to {...@link HttpServletResponse#sendError(int,
String)
+ * to {...@link HttpServletResponse#sendError(int,
String)}
* throws an {...@link IOException}
*/
protected void forwardToLoginPage(Request request,
@@ -338,7 +338,7 @@ public class FormAuthenticator
* @param config Login configuration describing how authentication
* should be performed
* @throws IOException If the forward to the error page fails and the call
- * to {...@link HttpServletResponse#sendError(int,
String)
+ * to {...@link HttpServletResponse#sendError(int,
String)}
* throws an {...@link IOException}
*/
protected void forwardToErrorPage(Request request,
Modified: tomcat/trunk/java/org/apache/catalina/connector/Request.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/connector/Request.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/connector/Request.java (original)
+++ tomcat/trunk/java/org/apache/catalina/connector/Request.java Wed Apr 14
22:27:59 2010
@@ -2266,7 +2266,7 @@ public class Request
* between nodes in a cluster and session fixation prevention during the
* authentication process.
*
- * @param session The session to change the session ID for
+ * @param newSessionId The session to change the session ID for
*/
public void changeSessionId(String newSessionId) {
// This should only ever be called if there was an old session ID but
Modified:
tomcat/trunk/java/org/apache/catalina/core/ApplicationSessionCookieConfig.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/core/ApplicationSessionCookieConfig.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
---
tomcat/trunk/java/org/apache/catalina/core/ApplicationSessionCookieConfig.java
(original)
+++
tomcat/trunk/java/org/apache/catalina/core/ApplicationSessionCookieConfig.java
Wed Apr 14 22:27:59 2010
@@ -106,7 +106,7 @@ public class ApplicationSessionCookieCon
/**
* Creates a new session cookie for the given session ID
*
- * @param conetxt The Context for the web application
+ * @param context The Context for the web application
* @param sessionId The ID of the session for which the cookie will be
* created
* @param secure Should session cookie be configured as secure
Modified: tomcat/trunk/java/org/apache/catalina/core/ContainerBase.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/core/ContainerBase.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/core/ContainerBase.java (original)
+++ tomcat/trunk/java/org/apache/catalina/core/ContainerBase.java Wed Apr 14
22:27:59 2010
@@ -1121,7 +1121,7 @@ public abstract class ContainerBase exte
* Convenience method, intended for use by the digester to simplify the
* process of adding Valves to containers. See
* {...@link Pipeline#addValve(Valve)} for full details. Components other
than
- * the digester should use {...@link #getPipeline()#addValve(Valve)} in
case a
+ * the digester should use {...@link #getPipeline()}...@link
#addValve(Valve)} in case a
* future implementation provides an alternative method for the digester to
* use.
*
Modified: tomcat/trunk/java/org/apache/catalina/core/StandardContext.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/core/StandardContext.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/core/StandardContext.java (original)
+++ tomcat/trunk/java/org/apache/catalina/core/StandardContext.java Wed Apr 14
22:27:59 2010
@@ -2307,9 +2307,9 @@ public class StandardContext
/**
- * Set the clearReferencesStopThreads feature for this Context.
+ * Set the clearReferencesThreadLocals feature for this Context.
*
- * @param clearReferencesStopThreads The new flag value
+ * @param clearReferencesThreadLocals The new flag value
*/
public void setClearReferencesThreadLocals(
boolean clearReferencesThreadLocals) {
Modified: tomcat/trunk/java/org/apache/catalina/session/StandardSession.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/session/StandardSession.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/session/StandardSession.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/session/StandardSession.java Wed Apr
14 22:27:59 2010
@@ -430,7 +430,7 @@ public class StandardSession
/**
* Return the last client access time without invalidation check
- * @see #getThisAccessedTime().
+ * @see #getThisAccessedTime()
*/
public long getThisAccessedTimeInternal() {
return (this.thisAccessedTime);
@@ -455,7 +455,7 @@ public class StandardSession
/**
* Return the last client access time without invalidation check
- * @see #getLastAccessedTime().
+ * @see #getLastAccessedTime()
*/
public long getLastAccessedTimeInternal() {
return (this.lastAccessedTime);
Modified: tomcat/trunk/java/org/apache/catalina/tribes/ChannelListener.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/ChannelListener.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/ChannelListener.java (original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/ChannelListener.java Wed Apr
14 22:27:59 2010
@@ -61,7 +61,7 @@ public interface ChannelListener {
/**
*
* @return int
- * @see Object#hashCode(int)
+ * @see Object#hashCode()
*/
public int hashCode();
Modified: tomcat/trunk/java/org/apache/catalina/tribes/group/RpcChannel.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/tribes/group/RpcChannel.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/tribes/group/RpcChannel.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/tribes/group/RpcChannel.java Wed Apr
14 22:27:59 2010
@@ -66,7 +66,8 @@ public class RpcChannel implements Chann
* Send a message and wait for the response.
* @param destination Member[] - the destination for the message, and the
members you request a reply from
* @param message Serializable - the message you are sending out
- * @param options int - FIRST_REPLY, MAJORITY_REPLY or ALL_REPLY
+ * @param rpcOptions int - FIRST_REPLY, MAJORITY_REPLY or ALL_REPLY
+ * @param channelOptions channel sender options
* @param timeout long - timeout in milliseconds, if no reply is received
within this time null is returned
* @return Response[] - an array of response objects.
* @throws ChannelException
Modified: tomcat/trunk/java/org/apache/el/parser/AstValue.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/el/parser/AstValue.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/el/parser/AstValue.java (original)
+++ tomcat/trunk/java/org/apache/el/parser/AstValue.java Wed Apr 14 22:27:59
2010
@@ -283,7 +283,7 @@ public final class AstValue extends Simp
/**
- * @ since EL 2.2
+ * @since EL 2.2
*/
@Override
public boolean isParametersProvided() {
Modified: tomcat/trunk/java/org/apache/jasper/compiler/Node.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/jasper/compiler/Node.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/jasper/compiler/Node.java (original)
+++ tomcat/trunk/java/org/apache/jasper/compiler/Node.java Wed Apr 14 22:27:59
2010
@@ -2292,7 +2292,7 @@ abstract class Node implements TagConsta
/**
* @return true if the value represents an expression that should be
fed
* to the expression interpreter
- * @return false for string literals or rtexprvalues that should not be
+ * false for string literals or rtexprvalues that should not be
* interpreted or reevaluated
*/
public boolean isELInterpreterInput() {
Modified: tomcat/trunk/webapps/examples/WEB-INF/classes/chat/ChatServlet.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/examples/WEB-INF/classes/chat/ChatServlet.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/webapps/examples/WEB-INF/classes/chat/ChatServlet.java
(original)
+++ tomcat/trunk/webapps/examples/WEB-INF/classes/chat/ChatServlet.java Wed Apr
14 22:27:59 2010
@@ -194,14 +194,6 @@ public class ChatServlet
running = false;
}
- /**
- * Add specified socket and associated pool to the poller. The socket
will
- * be added to a temporary array, and polled first after a maximum
amount
- * of time equal to pollTime (in most cases, latency will be much
lower,
- * however).
- *
- * @param socket to add to the poller
- */
public void send(String user, String message) {
synchronized (messages) {
messages.add("[" + user + "]: " + message);
Modified:
tomcat/trunk/webapps/examples/WEB-INF/classes/filters/ExampleFilter.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/examples/WEB-INF/classes/filters/ExampleFilter.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
--- tomcat/trunk/webapps/examples/WEB-INF/classes/filters/ExampleFilter.java
(original)
+++ tomcat/trunk/webapps/examples/WEB-INF/classes/filters/ExampleFilter.java
Wed Apr 14 22:27:59 2010
@@ -82,7 +82,7 @@ public final class ExampleFilter impleme
* current filter stack, including the ultimately invoked servlet.
*
* @param request The servlet request we are processing
- * @param result The servlet response we are creating
+ * @param response The servlet response we are creating
* @param chain The filter chain we are processing
*
* @exception IOException if an input/output error occurs
Modified:
tomcat/trunk/webapps/examples/WEB-INF/classes/filters/SetCharacterEncodingFilter.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/examples/WEB-INF/classes/filters/SetCharacterEncodingFilter.java?rev=934224&r1=934223&r2=934224&view=diff
==============================================================================
---
tomcat/trunk/webapps/examples/WEB-INF/classes/filters/SetCharacterEncodingFilter.java
(original)
+++
tomcat/trunk/webapps/examples/WEB-INF/classes/filters/SetCharacterEncodingFilter.java
Wed Apr 14 22:27:59 2010
@@ -101,7 +101,7 @@ public class SetCharacterEncodingFilter
* interpret request parameters for this request.
*
* @param request The servlet request we are processing
- * @param result The servlet response we are creating
+ * @param response The servlet response we are creating
* @param chain The filter chain we are processing
*
* @exception IOException if an input/output error occurs
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
