Fix https://issues.apache.org/bugzilla/show_bug.cgi?id=49105
authormarkt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Wed, 14 Apr 2010 22:27:59 +0000 (22:27 +0000)
committermarkt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Wed, 14 Apr 2010 22:27:59 +0000 (22:27 +0000)
Misc Javadoc corrections.

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

20 files changed:
java/javax/el/ExpressionFactory.java
java/javax/servlet/HttpConstraintElement.java
java/javax/servlet/ServletContext.java
java/org/apache/catalina/Context.java
java/org/apache/catalina/Host.java
java/org/apache/catalina/Lifecycle.java
java/org/apache/catalina/Session.java
java/org/apache/catalina/authenticator/FormAuthenticator.java
java/org/apache/catalina/connector/Request.java
java/org/apache/catalina/core/ApplicationSessionCookieConfig.java
java/org/apache/catalina/core/ContainerBase.java
java/org/apache/catalina/core/StandardContext.java
java/org/apache/catalina/session/StandardSession.java
java/org/apache/catalina/tribes/ChannelListener.java
java/org/apache/catalina/tribes/group/RpcChannel.java
java/org/apache/el/parser/AstValue.java
java/org/apache/jasper/compiler/Node.java
webapps/examples/WEB-INF/classes/chat/ChatServlet.java
webapps/examples/WEB-INF/classes/filters/ExampleFilter.java
webapps/examples/WEB-INF/classes/filters/SetCharacterEncodingFilter.java

index 6295096..6f44136 100644 (file)
@@ -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;
index f70ad74..f9b885d 100644 (file)
@@ -43,7 +43,7 @@ public class HttpConstraintElement {
     }
     
     /**
-     * Convenience constructor for {@link EmptyRoleSemantic.DENY}.
+     * Convenience constructor for {@link EmptyRoleSemantic#DENY}.
      * 
      */
     public HttpConstraintElement(EmptyRoleSemantic emptyRoleSemantic) {
index 14448b6..c6be08b 100644 (file)
@@ -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
index 53c4974..9e5c467 100644 (file)
@@ -738,7 +738,7 @@ public interface Context extends Container {
      *
      * @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,
index b205de9..07499cd 100644 (file)
@@ -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();
     /**
index 7c3fd50..2ba8514 100644 (file)
@@ -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}.
  * 
index 18f4b8d..b805920 100644 (file)
@@ -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();
 
index 0cf369c..99c7038 100644 (file)
@@ -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,
index d184342..02b0cd7 100644 (file)
@@ -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
index 1a148e2..1db3b57 100644 (file)
@@ -106,7 +106,7 @@ public class ApplicationSessionCookieConfig implements SessionCookieConfig {
     /**
      * 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
index ae8fa9e..f18d9aa 100644 (file)
@@ -1121,7 +1121,7 @@ public abstract class ContainerBase extends LifecycleBase
      * 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.
      *
index 7221140..eedc91c 100644 (file)
@@ -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) {
index 0770329..03e21fd 100644 (file)
@@ -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);
index d329b86..ea81f2e 100644 (file)
@@ -61,7 +61,7 @@ public interface ChannelListener {
     /**
      * 
      * @return int
-     * @see Object#hashCode(int)
+     * @see Object#hashCode()
      */
     public int hashCode();
 
index c2fd1c4..8f44f06 100644 (file)
@@ -66,7 +66,8 @@ public class RpcChannel implements ChannelListener{
      * 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
index 94c3bdf..4caacfd 100644 (file)
@@ -283,7 +283,7 @@ public final class AstValue extends SimpleNode {
 
     
     /**
-     * @ since EL 2.2
+     * @since EL 2.2
      */
     @Override
     public boolean isParametersProvided() {
index 1e4993b..d9327cc 100644 (file)
@@ -2292,7 +2292,7 @@ abstract class Node implements TagConstants {
         /**
          * @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() {
index 15f025a..1b8a619 100644 (file)
@@ -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);
index eb5a528..c26e7dd 100644 (file)
@@ -82,7 +82,7 @@ public final class ExampleFilter implements Filter {
      * 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
index ce6ff03..da64c17 100644 (file)
@@ -101,7 +101,7 @@ public class SetCharacterEncodingFilter implements Filter {
      * 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