add documentation stubs

source/Ox.UI/js/Menu/Ox.Menu.js

@@ -1,5 +1,5 @@
-// vim: et:ts=4:sw=4:sts=4:ft=javascript
 'use strict';
+
 /*@
 Ox.Menu <f:Ox.Element> Menu Object
     () ->              <f> Menu Object
@@ -591,14 +591,15 @@ Ox.Menu = function(options, self) {
     };
 
     /*@
-    addItemBefore <f>
+    addItemBefore <f> addItemBefore
     @*/
     that.addItemBefore = function(item, id) {
 
     };
 
     /*@
-    checkItem <f>
+    checkItem <f> checkItem
+        (id, checked) -> <u> check item, checked can be undefined/true or false
     @*/
     that.checkItem = function(id, checked) {
         Ox.Log('Menu', 'checkItem id', id)
@@ -629,12 +630,17 @@ Ox.Menu = function(options, self) {
         }
     };
 
+    /*@
+    clickItem <f> clickItem
+        (position, files) -> <o>  click item at position
+    @*/
     that.clickItem = function(position, files) {
         clickItem(position, files);
     };
 
     /*@
-    getItem <f>
+    getItem <f> getItem
+        (id) -> <o> get item
     @*/
     that.getItem = function(id) {
         //Ox.Log('Menu', 'getItem id', id)
@@ -660,7 +666,8 @@ Ox.Menu = function(options, self) {
     };
 
     /*@
-    getSubmenu <f>
+    getSubmenu <f> getSubmenu
+        (id) -> <o> get submenu by id
     @*/
     that.getSubmenu = function(id) {
         var ids = id.split('_'),
@@ -675,7 +682,8 @@ Ox.Menu = function(options, self) {
     }
 
     /*@
-    hasEnabledItems <f>
+    hasEnabledItems <f> hasEditableItems
+        () -> <b> menu has editable items
     @*/
     that.hasEnabledItems = function() {
         var ret = false;
@@ -688,7 +696,7 @@ Ox.Menu = function(options, self) {
     };
 
     /*@
-    hideMenu <f>
+    hideMenu <f> hideMenu
         () -> <f> Menu Object
     @*/
     that.hideMenu = function(hideParent) {
@@ -717,6 +725,10 @@ Ox.Menu = function(options, self) {
         return that;
     };
 
+    /*@
+    remove <f> remove
+        () -> <o> remove menu
+    @*/
     self.superRemove = that.remove;
     that.remove = function() {
         Ox.forEach(that.submenus, function(submenu) {
@@ -740,6 +752,10 @@ Ox.Menu = function(options, self) {
         return that;
     };
 
+    /*@
+    setItemTitle <f> setItemTitle 
+        (id, title) -> <o>  set item title
+    @*/
     that.setItemTitle = function(id, title) {
         var item = getItem(id);
         item && item.options({title: title});
@@ -803,6 +819,10 @@ Ox.Menu = function(options, self) {
         return that.is(':hidden') ? that.showMenu() : that.hideMenu();
     };
 
+    /*@
+    uncheckItem <f> uncheckItem
+        (id) -> <o>  uncheck item
+    @*/
     that.uncheckItem = function(id) {
         that.checkItem(id, false);
     };