diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/PathParamProvider.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/PathParamProvider.java index 92aa958eaf9..0f7f91f5055 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/PathParamProvider.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/PathParamProvider.java @@ -25,7 +25,7 @@ import java.util.Map; * in Jetty to expose Path Param values used during the {@link org.eclipse.jetty.websocket.jsr356.function.JsrEndpointFunctions} * resolution of methods. *

- * Mostly a feature of the JSR356 Server implementation and its @javax.websocket.server.PathParam annotation. + * Mostly a feature of the JSR356 Server implementation and its {@code @javax.websocket.server.PathParam} annotation. *

*/ public interface PathParamProvider diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/EncodeFailedFuture.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/EncodeFailedFuture.java index 82f6c25ec9f..9a765b80956 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/EncodeFailedFuture.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/encoders/EncodeFailedFuture.java @@ -26,7 +26,7 @@ import java.util.concurrent.TimeoutException; import javax.websocket.Encoder; /** - * A Future<Void> that is already failed as a result of an Encode error + * A {@code Future<Void>} that is already failed as a result of an Encode error */ public class EncodeFailedFuture implements Future { diff --git a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/function/JsrEndpointFunctions.java b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/function/JsrEndpointFunctions.java index fb4c9e2804d..ac6a9541b0c 100644 --- a/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/function/JsrEndpointFunctions.java +++ b/jetty-websocket/javax-websocket-client-impl/src/main/java/org/eclipse/jetty/websocket/jsr356/function/JsrEndpointFunctions.java @@ -183,7 +183,7 @@ public class JsrEndpointFunctions extends CommonEndpointFunctions * Block if the message sink is actively being used. * * @param handler the handler to remove from possible message sinks - * @see {@link javax.websocket.Session#removeMessageHandler(MessageHandler)} + * @see javax.websocket.Session#removeMessageHandler(MessageHandler) * @since JSR356 v1.0 */ public void removeMessageHandler(MessageHandler handler) @@ -220,7 +220,7 @@ public class JsrEndpointFunctions extends CommonEndpointFunctions * @param handler the partial message handler * @param the generic defined type * @throws IllegalStateException if unable to process message handler - * @see {@link javax.websocket.Session#addMessageHandler(Class, MessageHandler.Partial)} + * @see javax.websocket.Session#addMessageHandler(Class, MessageHandler.Partial) * @since JSR356 v1.1 */ public void setMessageHandler(Class clazz, MessageHandler.Partial handler) throws IllegalStateException @@ -275,7 +275,7 @@ public class JsrEndpointFunctions extends CommonEndpointFunctions * @param handler the whole message handler * @param the generic defined type * @throws IllegalStateException if unable to process message handler - * @see {@link javax.websocket.Session#addMessageHandler(Class, MessageHandler.Whole)} + * @see javax.websocket.Session#addMessageHandler(Class, MessageHandler.Whole) * @since JSR356 v1.1 */ public void setMessageHandler(Class clazz, MessageHandler.Whole handler) throws IllegalStateException diff --git a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/StreamTest.java b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/StreamTest.java index 4b59658db31..d14306e11f7 100644 --- a/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/StreamTest.java +++ b/jetty-websocket/javax-websocket-server-impl/src/test/java/org/eclipse/jetty/websocket/jsr356/server/StreamTest.java @@ -164,7 +164,7 @@ public class StreamTest * * @param file * the file to validate - * @param shaFile + * @param sha1File * the sha1sum file to verify against */ private void assertFileUpload(File file, File sha1File) throws IOException, NoSuchAlgorithmException diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketPartialListener.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketPartialListener.java index 246da10d662..5fbebf5ace0 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketPartialListener.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/WebSocketPartialListener.java @@ -28,7 +28,7 @@ public interface WebSocketPartialListener extends WebSocketConnectionListener /** * A WebSocket BINARY (or associated CONTINUATION) frame has been received. *

- * Important Note: The payload ByteBuffer cannot be modified, and the ByteBuffer object itself + * Important Note: The payload {@code ByteBuffer} cannot be modified, and the ByteBuffer object itself * will be recycled on completion of this method call, make a copy of the data contained within if you want to * retain it between calls. * diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketClose.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketClose.java index 5305451c421..ba17796aa07 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketClose.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketClose.java @@ -30,9 +30,9 @@ import org.eclipse.jetty.websocket.api.Session; * Annotation for tagging methods to receive connection close events. *

* Acceptable method patterns.
- * Note: methodName can be any name you want to use. + * Note: {@code methodName} can be any name you want to use. *

    - *
  1. public void methodName(int statusCode, String reason)
    2. + *
  2. {@code public void methodName(int statusCode, String reason)}
    3. *
  3. public void methodName({@link Session} session, int statusCode, String reason)
    4. *
*/ diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketConnect.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketConnect.java index c99daf77414..84fc4a93bab 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketConnect.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketConnect.java @@ -30,7 +30,7 @@ import org.eclipse.jetty.websocket.api.Session; * Annotation for tagging methods to receive connection open events. *

* Only 1 acceptable method pattern for this annotation.
- * Note: methodName can be any name you want to use. + * Note: {@code methodName} can be any name you want to use. *

    *
  1. public void methodName({@link Session} session)
    2. *
diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketError.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketError.java index acfb23cbb7e..496a1d45f9a 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketError.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketError.java @@ -30,7 +30,7 @@ import org.eclipse.jetty.websocket.api.Session; * Annotation for receiving websocket errors (exceptions) that have occurred internally in the websocket implementation. *

* Acceptable method patterns.
- * Note: methodName can be any name you want to use. + * Note: {@code methodName} can be any name you want to use. *

    *
  1. public void methodName({@link Throwable} error)
    2. *
  2. public void methodName({@link Session} session, {@link Throwable} error)
    3. diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketFrame.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketFrame.java index 27b0d44c537..4b46a43c275 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketFrame.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketFrame.java @@ -30,7 +30,7 @@ import org.eclipse.jetty.websocket.api.Session; * (ADVANCED) Annotation for tagging methods to receive frame events. *

    * Acceptable method patterns.
    - * Note: methodName can be any name you want to use. + * Note: {@code methodName} can be any name you want to use. *

      *
    1. public void methodName({@link org.eclipse.jetty.websocket.api.extensions.Frame} frame)
      2. *
    2. public void methodName({@link Session} session, {@link org.eclipse.jetty.websocket.api.extensions.Frame} frame)
      3. diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketMessage.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketMessage.java index a9148d4b28e..797ae833e9b 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketMessage.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/annotations/OnWebSocketMessage.java @@ -31,13 +31,13 @@ import org.eclipse.jetty.websocket.api.Session; * Annotation for tagging methods to receive Binary or Text Message events. *

      * Acceptable method patterns.
      - * Note: methodName can be any name you want to use. + * Note: {@code methodName} can be any name you want to use. *

      * Text Message Versions *

        - *
      1. public void methodName(String text)
        2. + *
      2. {@code public void methodName(String text)}
        3. *
      3. public void methodName({@link Session} session, String text)
        4. - *
      4. public void methodName(Reader reader)
        5. + *
      5. {@code public void methodName(Reader reader)}
        6. *
      6. public void methodName({@link Session} session, Reader reader)
        7. *
      * Note: that the {@link Reader} in this case will always use UTF-8 encoding/charset (this is dictated by the RFC 6455 spec for Text Messages. If you need to @@ -45,9 +45,9 @@ import org.eclipse.jetty.websocket.api.Session; *

      * Binary Message Versions *

        - *
      1. public void methodName(byte buf[], int offset, int length)
        2. + *
      2. {@code public void methodName(byte buf[], int offset, int length)}
        3. *
      3. public void methodName({@link Session} session, byte buf[], int offset, int length)
        4. - *
      4. public void methodName(InputStream stream)
        5. + *
      5. {@code public void methodName(InputStream stream)}
        6. *
      6. public void methodName({@link Session} session, InputStream stream)
        7. *
      */ diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/Extension.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/Extension.java index 47c60f7cef0..7609e264efc 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/Extension.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/Extension.java @@ -33,9 +33,9 @@ public interface Extension extends IncomingFrames, OutgoingFrames public ExtensionConfig getConfig(); /** - * The Sec-WebSocket-Extensions name for this extension. + * The {@code Sec-WebSocket-Extensions} name for this extension. *

      - * Also known as the extension-token per Section 9.1. Negotiating Extensions. + * Also known as the {@code extension-token} per Section 9.1. Negotiating Extensions. * @return the name of the extension */ public String getName(); diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/ExtensionConfig.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/ExtensionConfig.java index d560bcf9062..4ede50508cf 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/ExtensionConfig.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/extensions/ExtensionConfig.java @@ -46,7 +46,7 @@ public class ExtensionConfig } /** - * Parse enumeration of Sec-WebSocket-Extensions header values into a {@link ExtensionConfig} list + * Parse enumeration of {@code Sec-WebSocket-Extensions} header values into a {@link ExtensionConfig} list * * @param valuesEnum * the raw header values enum @@ -73,7 +73,7 @@ public class ExtensionConfig } /** - * Parse 1 or more raw Sec-WebSocket-Extensions header values into a {@link ExtensionConfig} list + * Parse 1 or more raw {@code Sec-WebSocket-Extensions} header values into a {@link ExtensionConfig} list * * @param rawSecWebSocketExtensions * the raw header values diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/QuoteUtil.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/QuoteUtil.java index abc2adb47af..7d3ca781b15 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/QuoteUtil.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/QuoteUtil.java @@ -322,7 +322,7 @@ public class QuoteUtil /** * Append into buf the provided string, adding quotes if needed. *

      - * Quoting is determined if any of the characters in the delim are found in the input str. + * Quoting is determined if any of the characters in the {@code delim} are found in the input str. * * @param buf * the buffer to append to diff --git a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/WSURI.java b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/WSURI.java index e835bdee5b7..f956afeed1a 100644 --- a/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/WSURI.java +++ b/jetty-websocket/websocket-api/src/main/java/org/eclipse/jetty/websocket/api/util/WSURI.java @@ -28,9 +28,9 @@ import java.util.Objects; public final class WSURI { /** - * Convert to HTTP http or https scheme URIs. + * Convert to HTTP {@code http} or https scheme URIs. *

      - * Converting ws and wss URIs to their HTTP equivalent + * Converting {@code ws} and wss URIs to their HTTP equivalent * * @param inputUri * the input URI @@ -67,9 +67,9 @@ public final class WSURI } /** - * Convert to WebSocket ws or wss scheme URIs + * Convert to WebSocket {@code ws} or wss scheme URIs *

      - * Converting http and https URIs to their WebSocket equivalent + * Converting {@code http} and https URIs to their WebSocket equivalent * * @param inputUrl * the input URI @@ -83,9 +83,9 @@ public final class WSURI } /** - * Convert to WebSocket ws or wss scheme URIs + * Convert to WebSocket {@code ws} or wss scheme URIs *

      - * Converting http and https URIs to their WebSocket equivalent + * Converting {@code http} and https URIs to their WebSocket equivalent * * @param inputUrl * the input URI @@ -105,10 +105,10 @@ public final class WSURI } /** - * Convert to WebSocket ws or wss scheme URIs + * Convert to WebSocket {@code ws} or wss scheme URIs * *

      - * Converting http and https URIs to their WebSocket equivalent + * Converting {@code http} and https URIs to their WebSocket equivalent * * @param inputUri * the input URI diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/AcceptHash.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/AcceptHash.java index 57b52e456da..020b84c5cc2 100644 --- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/AcceptHash.java +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/AcceptHash.java @@ -24,14 +24,14 @@ import java.security.MessageDigest; import org.eclipse.jetty.util.B64Code; /** - * Logic for working with the Sec-WebSocket-Key and Sec-WebSocket-Accept headers. + * Logic for working with the {@code Sec-WebSocket-Key} and Sec-WebSocket-Accept headers. *

      * This is kept separate from Connection objects to facilitate difference in behavior between client and server, as well as making testing easier. */ public class AcceptHash { /** - * Globally Unique Identifier for use in WebSocket handshake within Sec-WebSocket-Accept and Sec-WebSocket-Key http headers. + * Globally Unique Identifier for use in WebSocket handshake within {@code Sec-WebSocket-Accept} and Sec-WebSocket-Key http headers. *

      * See Opening Handshake (Section 1.3) */ @@ -42,7 +42,7 @@ public class AcceptHash * * @param key * the key to hash - * @return the Sec-WebSocket-Accept header response (per opening handshake spec) + * @return the {@code Sec-WebSocket-Accept} header response (per opening handshake spec) */ public static String hashKey(String key) { diff --git a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/message/MessageInputStream.java b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/message/MessageInputStream.java index 0039f1862c1..3a4034acf52 100644 --- a/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/message/MessageInputStream.java +++ b/jetty-websocket/websocket-common/src/main/java/org/eclipse/jetty/websocket/common/message/MessageInputStream.java @@ -33,8 +33,9 @@ import org.eclipse.jetty.util.log.Logger; /** * Support class for reading a (single) WebSocket BINARY message via a InputStream. - *

      + *

      * An InputStream that can access a queue of ByteBuffer payloads, along with expected InputStream blocking behavior. + *

      */ public class MessageInputStream extends InputStream implements MessageSink { diff --git a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketServerFactory.java b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketServerFactory.java index 2f995f93564..10c23dabe39 100644 --- a/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketServerFactory.java +++ b/jetty-websocket/websocket-server/src/main/java/org/eclipse/jetty/websocket/server/WebSocketServerFactory.java @@ -507,7 +507,7 @@ public class WebSocketServerFactory extends ContainerLifeCycle implements WebSoc * @param request the request to upgrade * @param response the response to upgrade * @param websocket the websocket endpoint instance - * @throws IOException + * @throws IOException if unable to upgrade */ private boolean upgrade(HttpConnection http, ServletUpgradeRequest request, ServletUpgradeResponse response, Object websocket) throws IOException { diff --git a/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.java b/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.java index 30458d3564e..7d189dae6ff 100644 --- a/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.java +++ b/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.java @@ -164,7 +164,7 @@ public class ServletUpgradeRequest extends UpgradeRequest /** * Equivalent to {@link HttpServletRequest#getLocale()} * - * @return the preferred Locale for the client + * @return the preferred {@code Locale} for the client */ public Locale getLocale() {