some documentation

source/Ox.UI/js/Core/Ox.App.js

@@ -1,32 +1,21 @@
 // vim: et:ts=4:sw=4:sts=4:ft=js
-/*
-============================================================================
-Application
-============================================================================
-*/
 
-// fixme: get rid of launch, fire load event
+/*@
+Ox.App <f> Basic application instance that communicates with a JSON API
+    () ->              <f> App object
+    (options) ->       <f> App object
+    (options, self) -> <f> App object
+    options <o> Options object
+        timeout <n> request timeout
+        type    <s> 'GET' or 'POST'
+        url     <s> JSON API url
+    self <o>    Shared private variable
+    load <!>    app loaded
+
+@*/
 
 Ox.App = (function() {
 
-    /***
-    Ox.App
-        Basic application instance that communicates with a JSON API.
-        The JSON API must support at least the following actions:
-        api             returns all api methods
-        init            returns data (site, user, ...)
-    Options
-        timeout         API timeout in msec
-        type            'GET' or 'POST'
-        url             URL of the API
-    Methods
-        api[action]     make a request
-        api.cancel      cancel a request
-        options         get or set options
-    Events
-        load            app loaded
-    ***/
-
     return function(options) {
 
         options = options || {};
@@ -61,6 +50,12 @@ Ox.App = (function() {
             url: self.options.url
         });
 
+        /*@
+        api <o> bakcend API
+            [action] <f> all api requests available on backend
+            cancel   <f> cancel a request
+            options  <f> get or set options
+        @*/
         that.api.api(function(result) {
             Ox.forEach(result.data.actions, function(val, key) {
                 that.api[key] = function(data, callback) {