some documentation

source/Ox.UI/js/Core/Ox.Request.js

@@ -1,18 +1,14 @@
 // vim: et:ts=4:sw=4:sts=4:ft=js
-Ox.Request = function(options) {
+/*@
+Ox.Request <o> Basic request handler object
+FIXME: options is not a property, just documenting defaults
+options <o> Options object
+    timeout <n|60000> request timeout
+    type    <s|POST>  request type, possible values POST, GET, PUT, DELETE
+    url     <s>       request url
+@*/
 
-    /***
-    Ox.Request
-        Basic request handler
-    Options
-        timeout
-    Methods
-        cancel()        cancel request
-        clearCache()    clear cache
-        options()       get or set options
-        requests()      return number of active requests
-        send()          send request
-    ***/
+Ox.Request = function(options) {
 
     var cache = {},
         //dfd = $.Deferred(),
@@ -27,7 +23,12 @@ Ox.Request = function(options) {
         };
 
     return {
-
+        /*@
+        cancel <f> cancel pending requests
+            ()  -> <u>  cancel all requests
+            (f)  -> <u>  cancel all requests where function returns true
+            (n)  -> <u>  cancel request by id
+        @*/
         cancel: function() {
             if (arguments.length == 0) {
                 // cancel all requests
@@ -44,19 +45,42 @@ Ox.Request = function(options) {
                 delete requests[arguments[0]];
             }
         },
-
+        /*@
+        clearCache <f> clear cached results
+            () -> <u>
+        @*/
         clearCache: function() {
             cache = {};
         },
 
+        /*@
+        options <f> get/set options
+            ()        -> <o> get options
+            (options) -> <o> set options
+            options <o> Options Object
+        @*/
         options: function(options) {
             return Ox.getset(self.options, options, $.noop(), this);
         },
 
+        /*@
+        requests <f> pending requests
+            () -> <n> returns number of requests
+        @*/
         requests: function() {
             return Ox.len(requests);
         },
 
+        /*@
+        send <f> send request
+            (options) -> <n> returns request id
+            options <o> Options Object
+                age <n|-1> cache age
+                id <n|Ox.uid()> request id
+                timeout <n|self.options.timeout> overwrite default timeout
+                type <n|self.options.timeout> overwrite default type
+                url <n|self.options.timeout> overwrite default url
+        @*/
         send: function(options) {
 
             var options = $.extend({