From 0e5a89beccde6e7e78b6277934945b2dbd2a412a Mon Sep 17 00:00:00 2001
From: Bernard `Guyzmo` Pratz <guyzmo+github@m0g.net>
Date: Thu, 4 Apr 2013 19:07:11 +0200
Subject: [PATCH] added full comments to the new API functions.

Signed-off-by: Bernard `Guyzmo` Pratz <guyzmo+github@m0g.net>
---
 src/node/db/API.js | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/src/node/db/API.js b/src/node/db/API.js
index 8aa3dff72..dd2053f9c 100644
--- a/src/node/db/API.js
+++ b/src/node/db/API.js
@@ -77,19 +77,51 @@ exports.listSessionsOfAuthor = sessionManager.listSessionsOfAuthor;
 /**
 getAttributePool(padID) returns the attribute pool of a pad
 
+Example returns:
+{
+ "code":0,
+ "message":"ok",
+ "data": {
+    "pool":{
+        "numToAttrib":{
+            "0":["author","a.X4m8bBWJBZJnWGSh"],
+            "1":["author","a.TotfBPzov54ihMdH"],
+            "2":["author","a.StiblqrzgeNTbK05"],
+            "3":["bold","true"]
+        },
+        "attribToNum":{
+            "author,a.X4m8bBWJBZJnWGSh":0,
+            "author,a.TotfBPzov54ihMdH":1,
+            "author,a.StiblqrzgeNTbK05":2,
+            "bold,true":3
+        },
+        "nextNum":4
+    }
+ }
+}
+
 */
 exports.getAttributePool = function (padID, callback) 
 {
   getPadSafe(padID, true, function(err, pad)
   {
     if (ERR(err, callback)) return;
-    callbalk(null, {pool: pad.pool});
+    callback(null, {pool: pad.pool});
   });
 }
 
 /**
 getRevisionChangeset (padID, [rev])
 
+get the changeset at a given revision, or last revision if 'rev' is not defined.
+
+Example returns:
+{
+    "code" : 0,
+    "message" : "ok",
+    "data" : "Z:1>6b|5+6b$Welcome to Etherpad!\n\nThis pad text is synchronized as you type, so that everyone viewing this page sees the same text. This allows you to collaborate seamlessly on documents!\n\nGet involved with Etherpad at http://etherpad.org\n"
+}
+
 */
 exports.getRevisionChangeset = function(padID, rev, callback)
 {