From 31271daf04b9143675a6cc785967ffe6fc2a8415 Mon Sep 17 00:00:00 2001
From: Jeremiah Billmann <jcbillmann@yahoo.com>
Date: Fri, 26 Jul 2013 09:54:50 -0400
Subject: [PATCH] Progress:  Documentation

---
 README.md                     | 30 +++++++++++++++++++++++++++---
 client/garageserver.io.js     |  2 +-
 src/server/garageserver.io.js |  4 ++--
 3 files changed, 30 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 6ed051e..be9a5be 100644
--- a/README.md
+++ b/README.md
@@ -118,10 +118,13 @@ Type: object literal
 GarageServerIO.getStates(callback([, playerState], [, entityState]))
 ```
 
-**playerState**  
+**callback**  
+Type: function(playerStates, entityStates)
+
+**playerStates**  
 Type: array of object literals
 
-**entityState**  
+**entityStates**  
 Type: array of object literals
 
 ```js
@@ -172,13 +175,34 @@ GarageServerIO.stop()
 ```
 
 ```js
-GarageServerIO.getPlayers() : [,{ id, state, [,input1], [,{ state, executionTime }] }]
+GarageServerIO.getPlayers() : [,{ id, state, [,inputs], [,{ states, executionTimes }] }]
 ```
 
+**id**  
+Type: string
+
+**state**  
+Type: object literal
+
+**inputs**  
+Type: array of object literals
+
+**states**  
+Type: array of object literals
+
 ```js
 GarageServerIO.getEntities() : [,{ id, state, [,{ state, executionTime }] }]
 ```
 
+**id**  
+Type: string
+
+**state**  
+Type: object literal
+
+**states**  
+Type: array of object literals
+
 ```js
 GarageServerIO.updatePlayerState(id, state)
 ```
diff --git a/client/garageserver.io.js b/client/garageserver.io.js
index 9687328..4d44632 100644
--- a/client/garageserver.io.js
+++ b/client/garageserver.io.js
@@ -18,7 +18,7 @@ options = {
 api methods
     initializeGarageServer(path, options)
     addInput(input)
-    getStates(callback([player1State, player2State, ...], [entity1State, entity2State, ...]))
+    getStates(callback([, playerState], [, entityState]))
     getId() : playerid
     sendServerEvent(data)
 */
diff --git a/src/server/garageserver.io.js b/src/server/garageserver.io.js
index a37fbdc..32b8777 100644
--- a/src/server/garageserver.io.js
+++ b/src/server/garageserver.io.js
@@ -22,8 +22,8 @@ api methods
     createGarageServer(io, options)
     start()
     stop()
-    getPlayers() : [{ id, state, [input1, input2,...], [{ state1, executionTime1 }, { state2, executionTime2 }, ...] }]
-    getEntities() : [{ id, state, [{ state1, executionTime1 }, { state2, executionTime2 }, ...] }]
+    getPlayers() : [,{ id, state, [,inputs], [,{ states, executionTimes }] }]
+    getEntities() :[,{ id, state, [,{ state, executionTime }] }]
     updatePlayerState(id, state)
     updateEntityState(id, state)
     addEntity(id)