Add Javadoc

Author: rstoyanchev

spring-websocket/src/main/java/org/springframework/web/socket/BinaryMessage.java

@@ -25,7 +25,6 @@
  *
  * @author Rossen Stoyanchev
  * @since 4.0
- * @see WebSocketMessage
  */
 public final class BinaryMessage extends WebSocketMessage<ByteBuffer> {
 

spring-websocket/src/main/java/org/springframework/web/socket/WebSocketHandler.java

@@ -19,13 +19,14 @@
 /**
  * A handler for WebSocket messages and lifecycle events.
  *
- * <p> Implementations of this interface are encouraged to handle exceptions locally where
- * it makes sense or alternatively let the exception bubble up in which case the exception
- * is logged and the session closed with {@link CloseStatus#SERVER_ERROR SERVER_ERROR(1011)} by default.
- * The exception handling strategy is provided by
- * {@link org.springframework.web.socket.support.ExceptionWebSocketHandlerDecorator ExceptionWebSocketHandlerDecorator},
- * which can be customized or replaced by decorating the {@link WebSocketHandler} with a
- * different decorator.
+ * <p>
+ * Implementations of this interface are encouraged to handle exceptions locally where it
+ * makes sense or alternatively let the exception bubble up in which case the exception is
+ * logged and the session closed with {@link CloseStatus#SERVER_ERROR SERVER_ERROR(1011)}
+ * by default. The exception handling strategy is provided by
+ * {@link org.springframework.web.socket.support.ExceptionWebSocketHandlerDecorator
+ * ExceptionWebSocketHandlerDecorator}, which can be customized or replaced by decorating
+ * the {@link WebSocketHandler} with a different decorator.
  *
  * @param <T> The type of message being handled {@link TextMessage}, {@link BinaryMessage}
  *        (or {@link WebSocketMessage} for both).

spring-websocket/src/main/java/org/springframework/web/socket/WebSocketMessage.java

@@ -20,9 +20,7 @@
 import org.springframework.util.ObjectUtils;
 
 /**
- * A message that can be handled or sent during a WebSocket interaction. There are only
- * two sub-classes {@link BinaryMessage} or a {@link TextMessage} with no further
- * sub-classing expected.
+ * A message that can be handled or sent on a WebSocket connection.
  *
  * @author Rossen Stoyanchev
  * @since 4.0
@@ -43,7 +41,6 @@ public abstract class WebSocketMessage<T> {
 		this.payload = payload;
 	}
 
-
 	/**
 	 * Returns the message payload. This will never be {@code null}.
 	 */

spring-websocket/src/main/java/org/springframework/web/socket/WebSocketSession.java

@@ -17,12 +17,12 @@
 package org.springframework.web.socket;
 
 import java.io.IOException;
-import java.net.InetSocketAddress;
 import java.net.URI;
 import java.security.Principal;
 
 /**
- * Allows sending messages over a WebSocket connection as well as closing it.
+ * A WebSocket session abstraction. Allows sending messages over a WebSocket connection
+ * and closing it.
  *
  * @author Rossen Stoyanchev
  * @since 4.0

spring-websocket/src/main/java/org/springframework/web/socket/adapter/AbstractWebSocketSesssionAdapter.java

@@ -28,7 +28,7 @@
 
 
 /**
- * An base class for implementations adapting {@link WebSocketSession}.
+ * An abstract base class for implementations of {@link WebSocketSession}.
  *
  * @author Rossen Stoyanchev
  * @since 4.0

spring-websocket/src/main/java/org/springframework/web/socket/adapter/BinaryWebSocketHandlerAdapter.java

@@ -25,7 +25,9 @@
 
 
 /**
- * A {@link WebSocketHandler} for binary messages with empty methods.
+ * A convenient base class for {@link WebSocketHandler} implementation that process binary
+ * messages only. Text messages are rejected with {@link CloseStatus#NOT_ACCEPTABLE}. All
+ * other methods have empty implementations.
  *
  * @author Rossen Stoyanchev
  * @author Phillip Webb

spring-websocket/src/main/java/org/springframework/web/socket/adapter/ConfigurableWebSocketSession.java

@@ -23,6 +23,8 @@
 
 
 /**
+ * A WebSocketSession with configurable properties.
+ *
  * @author Rossen Stoyanchev
  * @since 4.0
  */

spring-websocket/src/main/java/org/springframework/web/socket/adapter/JettyWebSocketListenerAdapter.java

@@ -28,7 +28,7 @@
 import org.springframework.web.socket.support.ExceptionWebSocketHandlerDecorator;
 
 /**
- * Adapts Spring's {@link WebSocketHandler} to Jetty's {@link WebSocketListener}.
+ * Adapts {@link WebSocketHandler} to the Jetty 9 {@link WebSocketListener}.
  *
  * @author Phillip Webb
  * @since 4.0

spring-websocket/src/main/java/org/springframework/web/socket/adapter/JettyWebSocketSessionAdapter.java

@@ -31,7 +31,8 @@
 
 
 /**
- * Adapts Jetty's {@link Session} to Spring's {@link WebSocketSession}.
+ * Adapts a Jetty {@link org.eclipse.jetty.websocket.api.Session} to
+ * {@link WebSocketSession}.
  *
  * @author Phillip Webb
  * @author Rossen Stoyanchev

spring-websocket/src/main/java/org/springframework/web/socket/adapter/StandardEndpointAdapter.java

@@ -34,7 +34,7 @@
 
 
 /**
- * A wrapper around a {@link WebSocketHandler} that adapts it to {@link Endpoint}.
+ * Adapts a {@link WebSocketHandler} to a standard {@link Endpoint}.
  *
  * @author Rossen Stoyanchev
  * @since 4.0