From d03646a5c3fe27d4ec37f6e7f49ad12d370db702 Mon Sep 17 00:00:00 2001
From: Nikita <abracham.mitchell@gmail.com>
Date: Mon, 26 Feb 2018 10:53:17 +0300
Subject: [PATCH] javadoc errors fixed

---
 .../corundumstudio/socketio/AckRequest.java   |  2 +-
 .../socketio/Configuration.java               | 38 +++++++++----------
 .../socketio/HandshakeData.java               | 34 +++--------------
 .../socketio/MultiTypeArgs.java               |  5 ++-
 .../socketio/SocketIOChannelInitializer.java  |  4 +-
 .../socketio/SocketIOClient.java              |  6 +--
 .../socketio/SocketIONamespace.java           |  6 +--
 .../socketio/SocketIOServer.java              | 10 +++--
 .../socketio/annotation/OnEvent.java          |  2 +
 .../socketio/listener/DataListener.java       |  3 ++
 .../socketio/protocol/Packet.java             |  7 +++-
 11 files changed, 53 insertions(+), 64 deletions(-)

diff --git a/src/main/java/com/corundumstudio/socketio/AckRequest.java b/src/main/java/com/corundumstudio/socketio/AckRequest.java
index 31e28dd..b94f77c 100644
--- a/src/main/java/com/corundumstudio/socketio/AckRequest.java
+++ b/src/main/java/com/corundumstudio/socketio/AckRequest.java
@@ -25,7 +25,7 @@ import com.corundumstudio.socketio.protocol.PacketType;
 
 /**
  * Ack request received from Socket.IO client.
- * You can always check is it <code>true<code> through
+ * You can always check is it <code>true</code> through
  * {@link #isAckRequested()} method.
  *
  * You can call {@link #sendAckData} methods only during
diff --git a/src/main/java/com/corundumstudio/socketio/Configuration.java b/src/main/java/com/corundumstudio/socketio/Configuration.java
index d39e8c8..c39a2d3 100644
--- a/src/main/java/com/corundumstudio/socketio/Configuration.java
+++ b/src/main/java/com/corundumstudio/socketio/Configuration.java
@@ -161,7 +161,7 @@ public class Configuration {
      * Allows to setup custom implementation of
      * JSON serialization/deserialization
      *
-     * @param jsonSupport
+     * @param jsonSupport - json mapper
      *
      * @see JsonSupport
      */
@@ -177,7 +177,7 @@ public class Configuration {
      * Optional parameter. If not set then bind address
      * will be 0.0.0.0 or ::0
      *
-     * @param hostname
+     * @param hostname - name of host
      */
     public void setHostname(String hostname) {
         this.hostname = hostname;
@@ -258,7 +258,7 @@ public class Configuration {
     /**
      * SSL key store password
      *
-     * @param keyStorePassword
+     * @param keyStorePassword - password of key store
      */
     public void setKeyStorePassword(String keyStorePassword) {
         this.keyStorePassword = keyStorePassword;
@@ -270,7 +270,7 @@ public class Configuration {
     /**
      * SSL key store stream, maybe appointed to any source
      *
-     * @param keyStore
+     * @param keyStore - key store input stream
      */
     public void setKeyStore(InputStream keyStore) {
         this.keyStore = keyStore;
@@ -282,7 +282,7 @@ public class Configuration {
     /**
      * Key store format
      *
-     * @param keyStoreFormat
+     * @param keyStoreFormat - key store format
      */
     public void setKeyStoreFormat(String keyStoreFormat) {
         this.keyStoreFormat = keyStoreFormat;
@@ -389,7 +389,7 @@ public class Configuration {
      * Exception listener invoked on any exception in
      * SocketIO listener
      *
-     * @param exceptionListener
+     * @param exceptionListener - listener
      *
      * @see com.corundumstudio.socketio.listener.ExceptionListener
      */
@@ -406,7 +406,7 @@ public class Configuration {
     /**
      * TCP socket configuration
      *
-     * @param socketConfig
+     * @param socketConfig - config
      */
     public void setSocketConfig(SocketConfig socketConfig) {
         this.socketConfig = socketConfig;
@@ -418,7 +418,7 @@ public class Configuration {
      *
      * @see AckMode
      *
-     * @param ackMode
+     * @param ackMode - ack mode
      */
     public void setAckMode(AckMode ackMode) {
         this.ackMode = ackMode;
@@ -460,7 +460,7 @@ public class Configuration {
     /**
      * Set maximum websocket frame content length limit
      *
-     * @param maxContentLength
+     * @param maxFramePayloadLength - length
      */
     public void setMaxFramePayloadLength(int maxFramePayloadLength) {
         this.maxFramePayloadLength = maxFramePayloadLength;
@@ -472,7 +472,7 @@ public class Configuration {
     /**
      * Transport upgrade timeout in milliseconds
      *
-     * @param upgradeTimeout
+     * @param upgradeTimeout - upgrade timeout
      */
     public void setUpgradeTimeout(int upgradeTimeout) {
         this.upgradeTimeout = upgradeTimeout;
@@ -483,10 +483,10 @@ public class Configuration {
 
     /**
      * Adds <b>Server</b> header with lib version to http response.
-     * <p/>
+     * <p>
      * Default is <code>true</code>
      *
-     * @param addVersionHeader
+     * @param addVersionHeader - <code>true</code> to add header
      */
     public void setAddVersionHeader(boolean addVersionHeader) {
         this.addVersionHeader = addVersionHeader;
@@ -502,7 +502,7 @@ public class Configuration {
      *
      * If value is <code>null</code> then request <b>ORIGIN</b> header value used.
      *
-     * @param origin
+     * @param origin - origin
      */
     public void setOrigin(String origin) {
         this.origin = origin;
@@ -521,7 +521,7 @@ public class Configuration {
     /**
      * Set the name of the requested SSL protocol
      *
-     * @param sslProtocol
+     * @param sslProtocol - name of protocol
      */
     public void setSSLProtocol(String sslProtocol) {
         this.sslProtocol = sslProtocol;
@@ -535,7 +535,7 @@ public class Configuration {
      * Helps to avoid 'silent channel' attack and prevents
      * 'Too many open files' problem in this case
      *
-     * @param firstDataTimeout
+     * @param firstDataTimeout - timeout value
      */
     public void setFirstDataTimeout(int firstDataTimeout) {
         this.firstDataTimeout = firstDataTimeout;
@@ -547,10 +547,10 @@ public class Configuration {
     /**
      * Activate http protocol compression. Uses {@code gzip} or
      * {@code deflate} encoding choice depends on the {@code "Accept-Encoding"} header value.
-     * <p/>
+     * <p>
      * Default is <code>true</code>
      *
-     * @param httpCompression
+     * @param httpCompression - <code>true</code> to use http compression
      */
     public void setHttpCompression(boolean httpCompression) {
         this.httpCompression = httpCompression;
@@ -562,10 +562,10 @@ public class Configuration {
     /**
      * Activate websocket protocol compression.
      * Uses {@code permessage-deflate} encoding only.
-     * <p/>
+     * <p>
      * Default is <code>true</code>
      *
-     * @param websocketCompression
+     * @param websocketCompression - <code>true</code> to use websocket compression
      */
     public void setWebsocketCompression(boolean websocketCompression) {
         this.websocketCompression = websocketCompression;
diff --git a/src/main/java/com/corundumstudio/socketio/HandshakeData.java b/src/main/java/com/corundumstudio/socketio/HandshakeData.java
index 2148175..f7aa357 100644
--- a/src/main/java/com/corundumstudio/socketio/HandshakeData.java
+++ b/src/main/java/com/corundumstudio/socketio/HandshakeData.java
@@ -18,7 +18,6 @@ package com.corundumstudio.socketio;
 import java.io.Serializable;
 import java.net.InetSocketAddress;
 import java.util.Date;
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
@@ -57,7 +56,7 @@ public class HandshakeData implements Serializable {
     /**
      * Client network address
      *
-     * @return
+     * @return network address
      */
     public InetSocketAddress getAddress() {
         return address;
@@ -66,7 +65,7 @@ public class HandshakeData implements Serializable {
     /**
      * Connection local address
      *
-     * @return
+     * @return local address
      */
     public InetSocketAddress getLocal() {
         return local;
@@ -75,37 +74,16 @@ public class HandshakeData implements Serializable {
     /**
      * Http headers sent during first client request
      *
-     * @return
+     * @return headers
      */
     public HttpHeaders getHttpHeaders() {
         return headers;
     }
 
-    /**
-     * Use {@link #getHttpHeaders()}
-     */
-    @Deprecated
-    public Map<String, List<String>> getHeaders() {
-        Map<String, List<String>> result = new HashMap<String, List<String>>(headers.names().size());
-        for (String name : headers.names()) {
-            List<String> values = headers.getAll(name);
-            result.put(name, values);
-        }
-        return result;
-    }
-
-    /**
-     * Use {@link #getHttpHeaders().get()}
-     */
-    @Deprecated
-    public String getSingleHeader(String name) {
-        return headers.get(name);
-    }
-
     /**
      * Client connection date
      *
-     * @return
+     * @return date
      */
     public Date getTime() {
         return time;
@@ -114,7 +92,7 @@ public class HandshakeData implements Serializable {
     /**
      * Url used by client during first request
      *
-     * @return
+     * @return url
      */
     public String getUrl() {
         return url;
@@ -127,7 +105,7 @@ public class HandshakeData implements Serializable {
     /**
      * Url params stored in url used by client during first request
      *
-     * @return
+     * @return map
      */
     public Map<String, List<String>> getUrlParams() {
         return urlParams;
diff --git a/src/main/java/com/corundumstudio/socketio/MultiTypeArgs.java b/src/main/java/com/corundumstudio/socketio/MultiTypeArgs.java
index 3e8b35b..478f68c 100644
--- a/src/main/java/com/corundumstudio/socketio/MultiTypeArgs.java
+++ b/src/main/java/com/corundumstudio/socketio/MultiTypeArgs.java
@@ -50,8 +50,9 @@ public class MultiTypeArgs implements Iterable<Object> {
     /**
      * "index out of bounds"-safe method for getting elements
      *
-     * @param index
-     * @return
+     * @param <T> type of argument
+     * @param index to get
+     * @return argument
      */
     public <T> T get(int index) {
         if (size() <= index) {
diff --git a/src/main/java/com/corundumstudio/socketio/SocketIOChannelInitializer.java b/src/main/java/com/corundumstudio/socketio/SocketIOChannelInitializer.java
index 988306b..aac1f13 100644
--- a/src/main/java/com/corundumstudio/socketio/SocketIOChannelInitializer.java
+++ b/src/main/java/com/corundumstudio/socketio/SocketIOChannelInitializer.java
@@ -149,7 +149,7 @@ public class SocketIOChannelInitializer extends ChannelInitializer<Channel> impl
     /**
      * Adds the ssl handler
      *
-     * @return
+     * @param pipeline - channel pipeline
      */
     protected void addSslHandler(ChannelPipeline pipeline) {
         if (sslContext != null) {
@@ -162,7 +162,7 @@ public class SocketIOChannelInitializer extends ChannelInitializer<Channel> impl
     /**
      * Adds the socketio channel handlers
      *
-     * @param pipeline
+     * @param pipeline - channel pipeline
      */
     protected void addSocketioHandlers(ChannelPipeline pipeline) {
         pipeline.addLast(HTTP_REQUEST_DECODER, new HttpRequestDecoder());
diff --git a/src/main/java/com/corundumstudio/socketio/SocketIOClient.java b/src/main/java/com/corundumstudio/socketio/SocketIOClient.java
index 45453a9..e5572e0 100644
--- a/src/main/java/com/corundumstudio/socketio/SocketIOClient.java
+++ b/src/main/java/com/corundumstudio/socketio/SocketIOClient.java
@@ -91,21 +91,21 @@ public interface SocketIOClient extends ClientOperations, Store {
     /**
      * Join client to room
      *
-     * @param room
+     * @param room - name of room
      */
     void joinRoom(String room);
 
     /**
      * Join client to room
      *
-     * @param room
+     * @param room - name of room
      */
     void leaveRoom(String room);
 
     /**
      * Get all rooms a client is joined in.
      *
-     * @return
+     * @return name of rooms
      */
     Set<String> getAllRooms();
 
diff --git a/src/main/java/com/corundumstudio/socketio/SocketIONamespace.java b/src/main/java/com/corundumstudio/socketio/SocketIONamespace.java
index f361b90..7628358 100644
--- a/src/main/java/com/corundumstudio/socketio/SocketIONamespace.java
+++ b/src/main/java/com/corundumstudio/socketio/SocketIONamespace.java
@@ -35,15 +35,15 @@ public interface SocketIONamespace extends ClientListeners {
     /**
      * Get all clients connected to namespace
      *
-     * @return
+     * @return collection of clients
      */
     Collection<SocketIOClient> getAllClients();
 
     /**
      * Get client by uuid connected to namespace
      *
-     * @param uuid
-     * @return
+     * @param uuid - id of client
+     * @return client
      */
     SocketIOClient getClient(UUID uuid);
 
diff --git a/src/main/java/com/corundumstudio/socketio/SocketIOServer.java b/src/main/java/com/corundumstudio/socketio/SocketIOServer.java
index b1baa8e..71e1968 100644
--- a/src/main/java/com/corundumstudio/socketio/SocketIOServer.java
+++ b/src/main/java/com/corundumstudio/socketio/SocketIOServer.java
@@ -80,8 +80,8 @@ public class SocketIOServer implements ClientListeners {
     /**
      * Get client by uuid from default namespace
      *
-     * @param uuid
-     * @return
+     * @param uuid - id of client
+     * @return client
      */
     public SocketIOClient getClient(UUID uuid) {
         return namespacesHub.get(Namespace.DEFAULT_NAME).getClient(uuid);
@@ -104,8 +104,8 @@ public class SocketIOServer implements ClientListeners {
      * Get broadcast operations for clients within
      * room by <code>room</code> name
      *
-     * @param room
-     * @return
+     * @param room - name of room
+     * @return broadcast operations
      */
     public BroadcastOperations getRoomOperations(String room) {
         Iterable<SocketIOClient> clients = namespacesHub.getRoomClients(room);
@@ -121,6 +121,8 @@ public class SocketIOServer implements ClientListeners {
 
     /**
      * Start server asynchronously
+     * 
+     * @return void
      */
     public Future<Void> startAsync() {
         log.info("Session store / pubsub factory used: {}", configCopy.getStoreFactory());
diff --git a/src/main/java/com/corundumstudio/socketio/annotation/OnEvent.java b/src/main/java/com/corundumstudio/socketio/annotation/OnEvent.java
index 821f91b..c58fcf9 100644
--- a/src/main/java/com/corundumstudio/socketio/annotation/OnEvent.java
+++ b/src/main/java/com/corundumstudio/socketio/annotation/OnEvent.java
@@ -37,6 +37,8 @@ public @interface OnEvent {
 
     /**
      * Event name
+     * 
+     * @return value
      */
     String value();
 
diff --git a/src/main/java/com/corundumstudio/socketio/listener/DataListener.java b/src/main/java/com/corundumstudio/socketio/listener/DataListener.java
index c0f100d..ecb0aa1 100644
--- a/src/main/java/com/corundumstudio/socketio/listener/DataListener.java
+++ b/src/main/java/com/corundumstudio/socketio/listener/DataListener.java
@@ -25,6 +25,9 @@ public interface DataListener<T> {
      *
      * @param client - receiver
      * @param data - received object
+     * @param ackSender - ack request
+     * 
+     * @throws Exception
      */
     void onData(SocketIOClient client, T data, AckRequest ackSender) throws Exception;
 
diff --git a/src/main/java/com/corundumstudio/socketio/protocol/Packet.java b/src/main/java/com/corundumstudio/socketio/protocol/Packet.java
index 2d81f42..74f666b 100644
--- a/src/main/java/com/corundumstudio/socketio/protocol/Packet.java
+++ b/src/main/java/com/corundumstudio/socketio/protocol/Packet.java
@@ -65,9 +65,12 @@ public class Packet implements Serializable {
 
     /**
      * Get packet data
+     * 
+     * @param <T> the type data
+     * 
      * <pre>
-     * @return <b>json object</b> for {@link PacketType.JSON} type
-     * <b>message</b> for {@link PacketType.MESSAGE} type
+     * @return <b>json object</b> for PacketType.JSON type
+     * <b>message</b> for PacketType.MESSAGE type
      * </pre>
      */
     public <T> T getData() {