Author: markt
Date: Tue Aug 3 11:14:02 2010
New Revision: 981822
URL: http://svn.apache.org/viewvc?rev=981822&view=rev
Log:
More Javadoc fixes that were missed earlier
Modified:
tomcat/trunk/java/javax/servlet/AsyncContext.java
tomcat/trunk/java/javax/servlet/AsyncEvent.java
tomcat/trunk/java/javax/servlet/FilterConfig.java
tomcat/trunk/java/javax/servlet/GenericServlet.java
tomcat/trunk/java/javax/servlet/ServletContext.java
tomcat/trunk/java/javax/servlet/ServletRequestWrapper.java
tomcat/trunk/java/javax/servlet/annotation/WebInitParam.java
tomcat/trunk/java/javax/servlet/http/Cookie.java
Modified: tomcat/trunk/java/javax/servlet/AsyncContext.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/AsyncContext.java?rev=981822&r1=981821&r2=981822&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/AsyncContext.java (original)
+++ tomcat/trunk/java/javax/servlet/AsyncContext.java Tue Aug 3 11:14:02 2010
@@ -17,9 +17,9 @@
package javax.servlet;
/**
- * @since Servlet 3.0
* $Id$
* TODO SERVLET3 - Add comments
+ * @since Servlet 3.0
*/
public interface AsyncContext {
public static final String ASYNC_REQUEST_URI =
Modified: tomcat/trunk/java/javax/servlet/AsyncEvent.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/AsyncEvent.java?rev=981822&r1=981821&r2=981822&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/AsyncEvent.java (original)
+++ tomcat/trunk/java/javax/servlet/AsyncEvent.java Tue Aug 3 11:14:02 2010
@@ -17,8 +17,8 @@
package javax.servlet;
/**
- * @since Servlet 3.0
* TODO SERVLET3 - Add comments
+ * @since Servlet 3.0
*/
public class AsyncEvent {
private AsyncContext context;
Modified: tomcat/trunk/java/javax/servlet/FilterConfig.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/FilterConfig.java?rev=981822&r1=981821&r2=981822&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/FilterConfig.java (original)
+++ tomcat/trunk/java/javax/servlet/FilterConfig.java Tue Aug 3 11:14:02 2010
@@ -25,7 +25,7 @@ import java.util.Enumeration;
* to a filter during initialization.
*
* @see Filter
- * @sinceServlet 2.3
+ * @since Servlet 2.3
*/
public interface FilterConfig {
@@ -42,7 +42,7 @@ public interface FilterConfig {
* @return {...@link ServletContext} object, used by the caller to interact
* with its servlet container
*
- * @seeServletContext
+ * @see ServletContext
*/
public ServletContext getServletContext();
Modified: tomcat/trunk/java/javax/servlet/GenericServlet.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/GenericServlet.java?rev=981822&r1=981821&r2=981822&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/GenericServlet.java (original)
+++ tomcat/trunk/java/javax/servlet/GenericServlet.java Tue Aug 3 11:14:02 2010
@@ -20,23 +20,19 @@ import java.io.IOException;
import java.util.Enumeration;
/**
- *
* Defines a generic, protocol-independent servlet. To write an HTTP servlet
for
* use on the Web, extend {...@link javax.servlet.http.HttpServlet} instead.
- *
* <p>
* <code>GenericServlet</code> implements the <code>Servlet</code> and
* <code>ServletConfig</code> interfaces. <code>GenericServlet</code> may be
* directly extended by a servlet, although it's more common to extend a
* protocol-specific subclass such as <code>HttpServlet</code>.
- *
* <p>
* <code>GenericServlet</code> makes writing servlets easier. It provides
simple
* versions of the lifecycle methods <code>init</code> and <code>destroy</code>
* and of the methods in the <code>ServletConfig</code> interface.
* <code>GenericServlet</code> also implements the <code>log</code> method,
* declared in the <code>ServletContext</code> interface.
- *
* <p>
* To write a generic servlet, you need only override the abstract
* <code>service</code> method.
@@ -68,7 +64,6 @@ public abstract class GenericServlet imp
* Returns a <code>String</code> containing the value of the named
* initialization parameter, or <code>null</code> if the parameter does not
* exist. See {...@link ServletConfig#getInitParameter}.
- *
* <p>
* This method is supplied for convenience. It gets the value of the named
* parameter from the servlet's <code>ServletConfig</code> object.
@@ -76,7 +71,6 @@ public abstract class GenericServlet imp
* @param name
* a <code>String</code> specifying the name of the
* initialization parameter
- *
* @return String a <code>String</code> containing the value of the
* initialization parameter
*/
@@ -89,7 +83,6 @@ public abstract class GenericServlet imp
* <code>Enumeration</code> of <code>String</code> objects, or an empty
* <code>Enumeration</code> if the servlet has no initialization
parameters.
* See {...@link ServletConfig#getInitParameterNames}.
- *
* <p>
* This method is supplied for convenience. It gets the parameter names
from
* the servlet's <code>ServletConfig</code> object.
@@ -114,12 +107,10 @@ public abstract class GenericServlet imp
/**
* Returns a reference to the {...@link ServletContext} in which this
servlet
* is running. See {...@link ServletConfig#getServletContext}.
- *
* <p>
* This method is supplied for convenience. It gets the context from the
* servlet's <code>ServletConfig</code> object.
*
- *
* @return ServletContext the <code>ServletContext</code> object passed to
* this servlet by the <code>init</code> method
*/
@@ -142,7 +133,6 @@ public abstract class GenericServlet imp
/**
* Called by the servlet container to indicate to a servlet that the
servlet
* is being placed into service. See {...@link Servlet#init}.
- *
* <p>
* This implementation stores the {...@link ServletConfig} object it
receives
* from the servlet container for later use. When overriding this form of
@@ -151,11 +141,9 @@ public abstract class GenericServlet imp
* @param config
* the <code>ServletConfig</code> object that contains
* configuration information for this servlet
- *
* @exception ServletException
* if an exception occurs that interrupts the servlet's
* normal operation
- *
* @see UnavailableException
*/
public void init(ServletConfig config) throws ServletException {
@@ -166,7 +154,6 @@ public abstract class GenericServlet imp
/**
* A convenience method which can be overridden so that there's no need to
* call <code>super.init(config)</code>.
- *
* <p>
* Instead of overriding {...@link #init(ServletConfig)}, simply override
this
* method and it will be called by
@@ -201,9 +188,8 @@ public abstract class GenericServlet imp
*
* @param message
* a <code>String</code> that describes the error or exception
- *
- * @param tthe
- * <code>java.lang.Throwable</code> error or exception
+ * @param t
+ * the <code>java.lang.Throwable</code> error or exception
*/
public void log(String message, Throwable t) {
getServletContext().log(getServletName() + ": " + message, t);
@@ -212,7 +198,6 @@ public abstract class GenericServlet imp
/**
* Called by the servlet container to allow the servlet to respond to a
* request. See {...@link Servlet#service}.
- *
* <p>
* This method is declared abstract so subclasses, such as
* <code>HttpServlet</code>, must override it.
@@ -220,15 +205,12 @@ public abstract class GenericServlet imp
* @param req
* the <code>ServletRequest</code> object that contains the
* client's request
- *
* @param res
* the <code>ServletResponse</code> object that will contain the
* servlet's response
- *
* @exception ServletException
* if an exception occurs that interferes with the servlet's
* normal operation occurred
- *
* @exception IOException
* if an input or output exception occurs
*/
Modified: tomcat/trunk/java/javax/servlet/ServletContext.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletContext.java?rev=981822&r1=981821&r2=981822&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletContext.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletContext.java Tue Aug 3 11:14:02 2010
@@ -678,7 +678,6 @@ public interface ServletContext {
/**
* @param <T>
* @param t
- * @return TODO
* @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public <T extends EventListener> void addListener(T t);
Modified: tomcat/trunk/java/javax/servlet/ServletRequestWrapper.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/ServletRequestWrapper.java?rev=981822&r1=981821&r2=981822&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/ServletRequestWrapper.java (original)
+++ tomcat/trunk/java/javax/servlet/ServletRequestWrapper.java Tue Aug 3
11:14:02 2010
@@ -316,7 +316,6 @@ public class ServletRequestWrapper imple
* The default behavior of this method is to return getServletContext() on
* the wrapped request object.
*
- * @return
* @since Servlet 3.0
*/
public ServletContext getServletContext() {
@@ -327,7 +326,6 @@ public class ServletRequestWrapper imple
* The default behavior of this method is to return startAsync() on the
* wrapped request object.
*
- * @return
* @throws java.lang.IllegalStateException
* @since Servlet 3.0
*/
@@ -341,7 +339,6 @@ public class ServletRequestWrapper imple
*
* @param servletRequest
* @param servletResponse
- * @return
* @throws java.lang.IllegalStateException
* @since Servlet 3.0
*/
@@ -354,7 +351,6 @@ public class ServletRequestWrapper imple
* The default behavior of this method is to return isAsyncStarted() on the
* wrapped request object.
*
- * @return
* @since Servlet 3.0
*/
public boolean isAsyncStarted() {
@@ -365,7 +361,6 @@ public class ServletRequestWrapper imple
* The default behavior of this method is to return isAsyncSupported() on
* the wrapped request object.
*
- * @return
* @since Servlet 3.0
*/
public boolean isAsyncSupported() {
@@ -376,7 +371,6 @@ public class ServletRequestWrapper imple
* The default behavior of this method is to return getAsyncContext() on
the
* wrapped request object.
*
- * @return
* @since Servlet 3.0
*/
public AsyncContext getAsyncContext() {
Modified: tomcat/trunk/java/javax/servlet/annotation/WebInitParam.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/annotation/WebInitParam.java?rev=981822&r1=981821&r2=981822&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/annotation/WebInitParam.java (original)
+++ tomcat/trunk/java/javax/servlet/annotation/WebInitParam.java Tue Aug 3
11:14:02 2010
@@ -30,7 +30,7 @@ import java.lang.annotation.Target;
* <br />
*
* E.g.
- * <code>@WebServlet(name="TestServlet",
urlPatterns={"/test"},initparam...@webinitparam(name="test", value="true")})
+ * <code>&#064;WebServlet(name="TestServlet",
urlPatterns={"/test"},initParams={&#064;WebInitParam(name="test",
value="true")})
* public class TestServlet extends HttpServlet { ... </code><br />
*
* @since Servlet 3.0
Modified: tomcat/trunk/java/javax/servlet/http/Cookie.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/javax/servlet/http/Cookie.java?rev=981822&r1=981821&r2=981822&view=diff
==============================================================================
--- tomcat/trunk/java/javax/servlet/http/Cookie.java (original)
+++ tomcat/trunk/java/javax/servlet/http/Cookie.java Tue Aug 3 11:14:02 2010
@@ -451,7 +451,7 @@ public class Cookie implements Cloneable
}
/**
- * @return
+ * @return TODO
* @since Servlet 3.0 TODO SERVLET3 - Add comments
*/
public boolean isHttpOnly() {
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
