Add comment on crib-enable.js

crib-enable.js

@@ -109,6 +109,12 @@
       }
     })
     
+    /**
+     * allDocs return the list of document in the cache
+     *
+     * @params {Object} Not taken into account 
+     * @return {} Return the data url of the document
+    */
     .declareMethod('allDocs', function(params) {
       if (params && params.cached_only) {
         return new RSVP.Queue()
@@ -126,6 +132,13 @@
       });      
     })
     
+    /**
+     * get Return a data url. Cannot return a blob as the data
+     * is transmitted through an iFrame
+     *
+     * @url  {string} url of the document to retrieve 
+     * @return {data_url} Return the data url of the document
+    */
     .declareMethod('get', function(url) {
       return new RSVP.Queue()
       .push(function () {
@@ -144,6 +157,14 @@
       });
     })
     
+    /**
+     * put Return a data url. Cannot provide a blob as the data
+     * is transmitted through an iFrame
+     *
+     * @url  {string} url of the document to update 
+     * @parameter {data_url} data url of the document to put, it will be transformed in a blob 
+     * @return {data_url} Return the data url of the document
+    */
     .declareMethod('put', function(url, parameter) {
       return new RSVP.Queue()
       .push(function() {
@@ -159,6 +180,12 @@
       }).fail(setStatus);
     })
     
+    /**
+     * Remove an url from the cache
+     *
+     * @url  {string} url of the document to remove 
+     * @return {}
+    */
     .declareMethod('remove', function(url) {
       return new RSVP.Queue()
         .push(function() {