From: markt Date: Tue, 3 Aug 2010 11:14:02 +0000 (+0000) Subject: More Javadoc fixes that were missed earlier X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=2d4a425179edb15897d22b0570e8e28ee354b2c8;p=tomcat7.0 More Javadoc fixes that were missed earlier git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@981822 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/java/javax/servlet/AsyncContext.java b/java/javax/servlet/AsyncContext.java index 66dec458d..a2ac2a3e7 100644 --- a/java/javax/servlet/AsyncContext.java +++ b/java/javax/servlet/AsyncContext.java @@ -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 = diff --git a/java/javax/servlet/AsyncEvent.java b/java/javax/servlet/AsyncEvent.java index cde734747..904685642 100644 --- a/java/javax/servlet/AsyncEvent.java +++ b/java/javax/servlet/AsyncEvent.java @@ -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; diff --git a/java/javax/servlet/FilterConfig.java b/java/javax/servlet/FilterConfig.java index 79fffd220..30bba6480 100644 --- a/java/javax/servlet/FilterConfig.java +++ b/java/javax/servlet/FilterConfig.java @@ -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(); diff --git a/java/javax/servlet/GenericServlet.java b/java/javax/servlet/GenericServlet.java index 15eb0f5e4..4e5f54cc9 100644 --- a/java/javax/servlet/GenericServlet.java +++ b/java/javax/servlet/GenericServlet.java @@ -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. - * *

* GenericServlet implements the Servlet and * ServletConfig interfaces. GenericServlet may be * directly extended by a servlet, although it's more common to extend a * protocol-specific subclass such as HttpServlet. - * *

* GenericServlet makes writing servlets easier. It provides simple * versions of the lifecycle methods init and destroy * and of the methods in the ServletConfig interface. * GenericServlet also implements the log method, * declared in the ServletContext interface. - * *

* To write a generic servlet, you need only override the abstract * service method. @@ -68,7 +64,6 @@ public abstract class GenericServlet implements Servlet, ServletConfig, * Returns a String containing the value of the named * initialization parameter, or null if the parameter does not * exist. See {@link ServletConfig#getInitParameter}. - * *

* This method is supplied for convenience. It gets the value of the named * parameter from the servlet's ServletConfig object. @@ -76,7 +71,6 @@ public abstract class GenericServlet implements Servlet, ServletConfig, * @param name * a String specifying the name of the * initialization parameter - * * @return String a String containing the value of the * initialization parameter */ @@ -89,7 +83,6 @@ public abstract class GenericServlet implements Servlet, ServletConfig, * Enumeration of String objects, or an empty * Enumeration if the servlet has no initialization parameters. * See {@link ServletConfig#getInitParameterNames}. - * *

* This method is supplied for convenience. It gets the parameter names from * the servlet's ServletConfig object. @@ -114,12 +107,10 @@ public abstract class GenericServlet implements Servlet, ServletConfig, /** * Returns a reference to the {@link ServletContext} in which this servlet * is running. See {@link ServletConfig#getServletContext}. - * *

* This method is supplied for convenience. It gets the context from the * servlet's ServletConfig object. * - * * @return ServletContext the ServletContext object passed to * this servlet by the init method */ @@ -142,7 +133,6 @@ public abstract class GenericServlet implements Servlet, ServletConfig, /** * Called by the servlet container to indicate to a servlet that the servlet * is being placed into service. See {@link Servlet#init}. - * *

* 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 implements Servlet, ServletConfig, * @param config * the ServletConfig 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 implements Servlet, ServletConfig, /** * A convenience method which can be overridden so that there's no need to * call super.init(config). - * *

* Instead of overriding {@link #init(ServletConfig)}, simply override this * method and it will be called by @@ -201,9 +188,8 @@ public abstract class GenericServlet implements Servlet, ServletConfig, * * @param message * a String that describes the error or exception - * - * @param tthe - * java.lang.Throwable error or exception + * @param t + * the java.lang.Throwable error or exception */ public void log(String message, Throwable t) { getServletContext().log(getServletName() + ": " + message, t); @@ -212,7 +198,6 @@ public abstract class GenericServlet implements Servlet, ServletConfig, /** * Called by the servlet container to allow the servlet to respond to a * request. See {@link Servlet#service}. - * *

* This method is declared abstract so subclasses, such as * HttpServlet, must override it. @@ -220,15 +205,12 @@ public abstract class GenericServlet implements Servlet, ServletConfig, * @param req * the ServletRequest object that contains the * client's request - * * @param res * the ServletResponse 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 */ diff --git a/java/javax/servlet/ServletContext.java b/java/javax/servlet/ServletContext.java index feadfb944..88d098d0e 100644 --- a/java/javax/servlet/ServletContext.java +++ b/java/javax/servlet/ServletContext.java @@ -678,7 +678,6 @@ public interface ServletContext { /** * @param * @param t - * @return TODO * @since Servlet 3.0 TODO SERVLET3 - Add comments */ public void addListener(T t); diff --git a/java/javax/servlet/ServletRequestWrapper.java b/java/javax/servlet/ServletRequestWrapper.java index 3c468bd44..b4610487c 100644 --- a/java/javax/servlet/ServletRequestWrapper.java +++ b/java/javax/servlet/ServletRequestWrapper.java @@ -316,7 +316,6 @@ public class ServletRequestWrapper implements ServletRequest { * 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 implements ServletRequest { * 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 implements ServletRequest { * * @param servletRequest * @param servletResponse - * @return * @throws java.lang.IllegalStateException * @since Servlet 3.0 */ @@ -354,7 +351,6 @@ public class ServletRequestWrapper implements ServletRequest { * 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 implements ServletRequest { * 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 implements ServletRequest { * The default behavior of this method is to return getAsyncContext() on the * wrapped request object. * - * @return * @since Servlet 3.0 */ public AsyncContext getAsyncContext() { diff --git a/java/javax/servlet/annotation/WebInitParam.java b/java/javax/servlet/annotation/WebInitParam.java index b99fa1cca..d4b757336 100644 --- a/java/javax/servlet/annotation/WebInitParam.java +++ b/java/javax/servlet/annotation/WebInitParam.java @@ -30,7 +30,7 @@ import java.lang.annotation.Target; *
* * E.g. - * @WebServlet(name="TestServlet", urlPatterns={"/test"},initParams={@WebInitParam(name="test", value="true")}) + * @WebServlet(name="TestServlet", urlPatterns={"/test"},initParams={@WebInitParam(name="test", value="true")}) * public class TestServlet extends HttpServlet { ...
* * @since Servlet 3.0 diff --git a/java/javax/servlet/http/Cookie.java b/java/javax/servlet/http/Cookie.java index 5a837a098..829b24254 100644 --- a/java/javax/servlet/http/Cookie.java +++ b/java/javax/servlet/http/Cookie.java @@ -451,7 +451,7 @@ public class Cookie implements Cloneable, Serializable { } /** - * @return + * @return TODO * @since Servlet 3.0 TODO SERVLET3 - Add comments */ public boolean isHttpOnly() {