From 19d8da3ee03225de91d0579a2d36f1af1e2a4da4 Mon Sep 17 00:00:00 2001
From: Nikita <abracham.mitchell@gmail.com>
Date: Fri, 7 Jun 2013 21:07:19 +0400
Subject: [PATCH] Some comments added

---
 .../com/corundumstudio/socketio/SocketIOClient.java    | 10 ++++++++++
 .../com/corundumstudio/socketio/SocketIOServer.java    |  9 ++++++++-
 2 files changed, 18 insertions(+), 1 deletion(-)

diff --git a/src/main/java/com/corundumstudio/socketio/SocketIOClient.java b/src/main/java/com/corundumstudio/socketio/SocketIOClient.java
index 1e2d337..da061f4 100644
--- a/src/main/java/com/corundumstudio/socketio/SocketIOClient.java
+++ b/src/main/java/com/corundumstudio/socketio/SocketIOClient.java
@@ -91,8 +91,18 @@ public interface SocketIOClient extends ClientOperations {
      */
     boolean isChannelOpen();
 
+    /**
+     * Join client to room
+     *
+     * @param roomKey - any object with correct hashcode & equals implementation
+     */
     <T> void joinRoom(T roomKey);
 
+    /**
+     * Join client to room
+     *
+     * @param roomKey - any object with correct hashcode & equals implementation
+     */
     <T> void leaveRoom(T roomKey);
 
 }
diff --git a/src/main/java/com/corundumstudio/socketio/SocketIOServer.java b/src/main/java/com/corundumstudio/socketio/SocketIOServer.java
index f22abb6..2790e18 100644
--- a/src/main/java/com/corundumstudio/socketio/SocketIOServer.java
+++ b/src/main/java/com/corundumstudio/socketio/SocketIOServer.java
@@ -60,7 +60,7 @@ public class SocketIOServer implements ClientListeners {
     /**
      * Get all clients
      *
-     * @return Iterable object with clients
+     * @return clients collection
      */
     public Collection<SocketIOClient> getAllClients() {
         return pipelineFactory.getAllClients();
@@ -70,6 +70,13 @@ public class SocketIOServer implements ClientListeners {
         return getBroadcastOperations(pipelineFactory.getAllClients());
     }
 
+    /**
+     * Get broadcast operations for clients within
+     * room by <code>roomKey</code>
+     *
+     * @param roomKey - any object with correct hashcode & equals implementation
+     * @return
+     */
     public <T> BroadcastOperations getRoomOperations(T roomKey) {
         Iterable<SocketIOClient> clients = namespacesHub.getRoomClients(roomKey);
         return new BroadcastOperations(clients);