Bug 942393 - Add more documentation to Australis' CustomizableUI, rs=me, DONTBUILD (comments-only)
authorGijs Kruitbosch <gijskruitbosch@gmail.com>
Mon, 06 Jan 2014 15:08:26 +0000
changeset 162235 70c67626470c213903c74718cf510b1bdcfe6d5e
parent 162234 77d3d487c68d98f4e984d78046312c6d265eb2b9
child 162236 2068b0f801c9e3d680aeff54bddcaddebab13624
push id25941
push userkwierso@gmail.com
push dateTue, 07 Jan 2014 01:20:54 +0000
treeherdermozilla-central@ce917d3dd7c8 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersme, DONTBUILD
bugs942393
milestone29.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 942393 - Add more documentation to Australis' CustomizableUI, rs=me, DONTBUILD (comments-only)
browser/components/customizableui/src/CustomizableUI.jsm
--- a/browser/components/customizableui/src/CustomizableUI.jsm
+++ b/browser/components/customizableui/src/CustomizableUI.jsm
@@ -2084,35 +2084,83 @@ let CustomizableUIInternal = {
     }
 
     return true;
   }
 };
 Object.freeze(CustomizableUIInternal);
 
 this.CustomizableUI = {
+  /**
+   * Constant reference to the ID of the menu panel.
+   */
   get AREA_PANEL() "PanelUI-contents",
+  /**
+   * Constant reference to the ID of the navigation toolbar.
+   */
   get AREA_NAVBAR() "nav-bar",
+  /**
+   * Constant reference to the ID of the menubar's toolbar.
+   */
   get AREA_MENUBAR() "toolbar-menubar",
+  /**
+   * Constant reference to the ID of the tabstrip toolbar.
+   */
   get AREA_TABSTRIP() "TabsToolbar",
+  /**
+   * Constant reference to the ID of the bookmarks toolbar.
+   */
   get AREA_BOOKMARKS() "PersonalToolbar",
+  /**
+   * Constant reference to the ID of the addon-bar toolbar shim.
+   * Do not use, this will be removed as soon as reasonably possible.
+   * @deprecated
+   */
   get AREA_ADDONBAR() "addon-bar",
-
+  /**
+   * Constant indicating the area is a menu panel.
+   */
+  get TYPE_MENU_PANEL() "menu-panel",
+  /**
+   * Constant indicating the area is a toolbar.
+   */
+  get TYPE_TOOLBAR() "toolbar",
+
+  /**
+   * Constant indicating a XUL-type provider.
+   */
   get PROVIDER_XUL() "xul",
+  /**
+   * Constant indicating an API-type provider.
+   */
   get PROVIDER_API() "api",
+  /**
+   * Constant indicating dynamic (special) widgets: spring, spacer, and separator.
+   */
   get PROVIDER_SPECIAL() "special",
 
+  /**
+   * Constant indicating the widget is built-in
+   */
   get SOURCE_BUILTIN() "builtin",
+  /**
+   * Constant indicating the widget is externally provided
+   * (e.g. by add-ons or other items not part of the builtin widget set).
+   */
   get SOURCE_EXTERNAL() "external",
 
   get TYPE_BUTTON() "button",
-  get TYPE_MENU_PANEL() "menu-panel",
-  get TYPE_TOOLBAR() "toolbar",
-
+
+  /**
+   * The class used to distinguish items that span the entire menu panel.
+   */
   get WIDE_PANEL_CLASS() "panel-wide-item",
+  /**
+   * The (constant) number of columns in the menu panel.
+   */
   get PANEL_COLUMN_COUNT() 3,
 
   /**
    * Add a listener object that will get fired for various events regarding
    * customization.
    *
    * @param aListener the listener object to add
    *