Javadoc updates

This commit is contained in:
Joakim Erdfelt 2016-01-13 07:25:15 -07:00
parent 00c5efc056
commit 30308f2316
5 changed files with 8 additions and 9 deletions

View File

@ -177,12 +177,11 @@ public class SecureRequestCustomizer implements HttpConfiguration.Customizer
/** /**
* <p>
* Customizes the request attributes for general secure settings. * Customizes the request attributes for general secure settings.
* The default impl calls {@link Request#setSecure(boolean)} with true * The default impl calls {@link Request#setSecure(boolean)} with true
* and sets a response header if the Strict-Transport-Security options * and sets a response header if the Strict-Transport-Security options
* are set. * are set.
* </p> * @param request the request being customized
*/ */
protected void customizeSecure(Request request) protected void customizeSecure(Request request)
{ {

View File

@ -47,7 +47,7 @@ import org.eclipse.jetty.util.log.Logger;
/** ContextHandlerCollection. /** ContextHandlerCollection.
* *
* This {@link org.eclipse.jetty.server.handler.HandlerCollection} is creates a * This {@link org.eclipse.jetty.server.handler.HandlerCollection} is creates a
* {@link org.eclipse.jetty.http.PathMap} to it's contained handlers based * Map of contexts to it's contained handlers based
* on the context path and virtual hosts of any contained {@link org.eclipse.jetty.server.handler.ContextHandler}s. * on the context path and virtual hosts of any contained {@link org.eclipse.jetty.server.handler.ContextHandler}s.
* The contexts do not need to be directly contained, only children of the contained handlers. * The contexts do not need to be directly contained, only children of the contained handlers.
* Multiple contexts may have the same context path and they are called in order until one * Multiple contexts may have the same context path and they are called in order until one

View File

@ -69,8 +69,8 @@ public class ServletMapping
/* ------------------------------------------------------------ */ /* ------------------------------------------------------------ */
/** Test if the list of path specs contains a particular one. /** Test if the list of path specs contains a particular one.
* @param pathSpec * @param pathSpec the test pathspec
* @return * @return true if pathspec contains test spec
*/ */
public boolean containsPathSpec (String pathSpec) public boolean containsPathSpec (String pathSpec)
{ {

View File

@ -35,7 +35,7 @@ public interface LogicalConnection extends OutgoingFrames, SuspendToken
* <p> * <p>
* Basic usage: results in an non-blocking async write, then connection close. * Basic usage: results in an non-blocking async write, then connection close.
* *
* @see StatusCode * @see org.eclipse.jetty.websocket.api.StatusCode
* @see #close(int, String) * @see #close(int, String)
*/ */
public void close(); public void close();
@ -49,7 +49,7 @@ public interface LogicalConnection extends OutgoingFrames, SuspendToken
* the status code * the status code
* @param reason * @param reason
* the (optional) reason. (can be null for no reason) * the (optional) reason. (can be null for no reason)
* @see StatusCode * @see org.eclipse.jetty.websocket.api.StatusCode
*/ */
public void close(int statusCode, String reason); public void close(int statusCode, String reason);

View File

@ -69,14 +69,14 @@ public interface WebSocketContainerScope
/** /**
* A Session has been opened * A Session has been opened
* *
* @param the session that was opened * @param session the session that was opened
*/ */
public void onSessionOpened(WebSocketSession session); public void onSessionOpened(WebSocketSession session);
/** /**
* A Session has been closed * A Session has been closed
* *
* @param the session that was closed * @param session the session that was closed
*/ */
public void onSessionClosed(WebSocketSession session); public void onSessionClosed(WebSocketSession session);