Comments on Room methods.

socketio · Jun 11, 2015 · 1a5b6d4 · 1a5b6d4
1 parent f7e7c07
commit 1a5b6d4
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/index.js b/index.js
@@ -210,13 +210,27 @@ function Room(){
   this.length = 0;
 }
 
+/**
+ * Adds a socket to a room.
+ *
+ * @param {String} socket id
+ * @api private
+ */
+
 Room.prototype.add = function(id){
   if (!this.sockets.hasOwnProperty(id)) {
     this.sockets[id] = true;
     this.length++;
   }
 };
 
+/**
+ * Removes a socket from a room.
+ *
+ * @param {String} socket id
+ * @api private
+ */
+
 Room.prototype.del = function(id){
   if (this.sockets.hasOwnProperty(id)) {
     delete this.sockets[id];