diff options
author | Joakim Erdfelt | 2015-04-22 21:21:42 +0000 |
---|---|---|
committer | Joakim Erdfelt | 2015-04-22 21:21:53 +0000 |
commit | c9d8d07a636c73caeed65cee2f3c6419a87590bb (patch) | |
tree | 76628de620737fa44cc538a2a0ae044df6b53c72 /jetty-continuation/src/main/java/org/eclipse/jetty/continuation | |
parent | 9e6c8eade16269567dd72f94c24413d25db67442 (diff) | |
download | org.eclipse.jetty.project-c9d8d07a636c73caeed65cee2f3c6419a87590bb.tar.gz org.eclipse.jetty.project-c9d8d07a636c73caeed65cee2f3c6419a87590bb.tar.xz org.eclipse.jetty.project-c9d8d07a636c73caeed65cee2f3c6419a87590bb.zip |
464727 - Update Javadoc for Java 8 DocLint
Diffstat (limited to 'jetty-continuation/src/main/java/org/eclipse/jetty/continuation')
-rw-r--r-- | jetty-continuation/src/main/java/org/eclipse/jetty/continuation/Continuation.java | 19 | ||||
-rw-r--r-- | jetty-continuation/src/main/java/org/eclipse/jetty/continuation/ContinuationListener.java | 10 |
2 files changed, 13 insertions, 16 deletions
diff --git a/jetty-continuation/src/main/java/org/eclipse/jetty/continuation/Continuation.java b/jetty-continuation/src/main/java/org/eclipse/jetty/continuation/Continuation.java index ad7b9e8a71..a6ff70e949 100644 --- a/jetty-continuation/src/main/java/org/eclipse/jetty/continuation/Continuation.java +++ b/jetty-continuation/src/main/java/org/eclipse/jetty/continuation/Continuation.java @@ -24,10 +24,9 @@ import javax.servlet.ServletRequest; import javax.servlet.ServletResponse; import javax.servlet.ServletResponseWrapper; -/* ------------------------------------------------------------ */ /** * Continuation. - * + * <p> * A continuation is a mechanism by which a HTTP Request can be suspended and * restarted after a timeout or an asynchronous event has occurred. * <p> @@ -52,7 +51,7 @@ import javax.servlet.ServletResponseWrapper; * <p> * There are two distinct style of operation of the continuation API. * </p> - * <h3>Suspend/Resume Usage</h3> + * <h1>Suspend/Resume Usage</h1> * <p>The suspend/resume style is used when a servlet and/or * filter is used to generate the response after a asynchronous wait that is * terminated by an asynchronous handler. @@ -87,7 +86,7 @@ import javax.servlet.ServletResponseWrapper; * response.getOutputStream().write(process(results)); * } * </pre> - * <h3>Suspend/Complete Usage</h3> + * <h1>Suspend/Complete Usage</h1> * <p> * The suspend/complete style is used when an asynchronous handler is used to * generate the response: @@ -152,7 +151,7 @@ public interface Continuation * @param timeoutMs * The time in milliseconds to wait before expiring this * continuation after a call to {@link #suspend()} or {@link #suspend(ServletResponse)}. - * A timeout of <=0 means the continuation will never expire. + * A timeout of <=0 means the continuation will never expire. */ void setTimeout(long timeoutMs); @@ -164,8 +163,8 @@ public interface Continuation * <p> * After this method has been called, the lifecycle of the request will be * extended beyond the return to the container from the - * {@link Servlet#service(ServletRequest, ServletResponse)} method and - * {@link Filter#doFilter(ServletRequest, ServletResponse, FilterChain)} + * {@link javax.servlet.Servlet#service(ServletRequest, ServletResponse)} method and + * {@link javax.servlet.Filter#doFilter(ServletRequest, ServletResponse, FilterChain)} * calls. When a suspended request is returned to the container after * a dispatch, then the container will not commit the associated response * (unless an exception other than {@link ContinuationThrowable} is thrown). @@ -200,8 +199,8 @@ public interface Continuation * <p> * After this method has been called, the lifecycle of the request will be * extended beyond the return to the container from the - * {@link Servlet#service(ServletRequest, ServletResponse)} method and - * {@link Filter#doFilter(ServletRequest, ServletResponse, FilterChain)} + * {@link javax.servlet.Servlet#service(ServletRequest, ServletResponse)} method and + * {@link javax.servlet.Filter#doFilter(ServletRequest, ServletResponse, FilterChain)} * calls. When a suspended request is returned to the container after * a dispatch, then the container will not commit the associated response * (unless an exception other than {@link ContinuationThrowable} is thrown). @@ -365,7 +364,7 @@ public interface Continuation /** * Add a ContinuationListener. * - * @param listener + * @param listener the listener */ void addContinuationListener(ContinuationListener listener); diff --git a/jetty-continuation/src/main/java/org/eclipse/jetty/continuation/ContinuationListener.java b/jetty-continuation/src/main/java/org/eclipse/jetty/continuation/ContinuationListener.java index 1083f74e02..f30d5d3110 100644 --- a/jetty-continuation/src/main/java/org/eclipse/jetty/continuation/ContinuationListener.java +++ b/jetty-continuation/src/main/java/org/eclipse/jetty/continuation/ContinuationListener.java @@ -22,13 +22,11 @@ import java.util.EventListener; import javax.servlet.ServletRequestListener; - -/* ------------------------------------------------------------ */ -/** A Continuation Listener +/** + * A Continuation Listener * <p> * A ContinuationListener may be registered with a call to * {@link Continuation#addContinuationListener(ContinuationListener)}. - * */ public interface ContinuationListener extends EventListener { @@ -38,7 +36,7 @@ public interface ContinuationListener extends EventListener * any calls to {@link ServletRequestListener#requestDestroyed(javax.servlet.ServletRequestEvent)} * The response may still be written to during the call. * - * @param continuation + * @param continuation the continuation */ public void onComplete(Continuation continuation); @@ -48,7 +46,7 @@ public interface ContinuationListener extends EventListener * The response may be written to and the methods * {@link Continuation#resume()} or {@link Continuation#complete()} * may be called by a onTimeout implementation, - * @param continuation + * @param continuation the continuation */ public void onTimeout(Continuation continuation); |