Polishing

spring-websocket/src/main/java/org/springframework/web/socket/config/annotation/WebSocketMessageBrokerConfigurer.java

@@ -5,7 +5,7 @@
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- * http://www.apache.org/licenses/LICENSE-2.0
+ *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -16,6 +16,7 @@
 
 package org.springframework.web.socket.config.annotation;
 
+import java.util.List;
 
 import org.springframework.messaging.converter.MessageConverter;
 import org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver;
@@ -23,13 +24,12 @@ import org.springframework.messaging.handler.invocation.HandlerMethodReturnValue
 import org.springframework.messaging.simp.config.ChannelRegistration;
 import org.springframework.messaging.simp.config.MessageBrokerRegistry;
 
-import java.util.List;
-
 /**
  * Defines methods for configuring message handling with simple messaging
- * protocols (e.g. STOMP) from WebSocket clients. Typically used to customize
- * the configuration provided via
- * {@link org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker @EnableWebSocketMessageBroker}.
+ * protocols (e.g. STOMP) from WebSocket clients.
+ *
+ * <p>Typically used to customize the configuration provided via
+ * {@link EnableWebSocketMessageBroker @EnableWebSocketMessageBroker}.
  *
  * @author Rossen Stoyanchev
  * @since 4.0
@@ -69,7 +69,7 @@ public interface WebSocketMessageBrokerConfigurer {
 	 * <p>This does not override the built-in support for resolving handler
 	 * method arguments. To customize the built-in support for argument
 	 * resolution, configure {@code SimpAnnotationMethodMessageHandler} directly.
-	 * @param argumentResolvers initially an empty list
+	 * @param argumentResolvers the resolvers to register (initially an empty list)
 	 * @since 4.1.1
 	 */
 	void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers);
@@ -79,7 +79,7 @@ public interface WebSocketMessageBrokerConfigurer {
 	 * <p>Using this option does not override the built-in support for handling
 	 * return values. To customize the built-in support for handling return
 	 * values, configure  {@code SimpAnnotationMethodMessageHandler} directly.
-	 * @param returnValueHandlers initially an empty list
+	 * @param returnValueHandlers the handlers to register (initially an empty list)
 	 * @since 4.1.1
 	 */
 	void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers);
@@ -88,12 +88,10 @@ public interface WebSocketMessageBrokerConfigurer {
 	 * Configure the message converters to use when extracting the payload of
 	 * messages in annotated methods and when sending messages (e.g. through the
 	 * "broker" SimpMessagingTemplate).
-	 * <p>
-	 * The provided list, initially empty, can be used to add message converters
+	 * <p>The provided list, initially empty, can be used to add message converters
 	 * while the boolean return value is used to determine if default message should
 	 * be added as well.
-	 *
-	 * @param messageConverters initially an empty list of converters
+	 * @param messageConverters the converters to configure (initially an empty list)
 	 * @return whether to also add default converter or not
 	 */
 	boolean configureMessageConverters(List<MessageConverter> messageConverters);