Code review: better description of PanelManager/Resizer's use of DOM ids

Author: peterflynn

src/utils/Resizer.js

@@ -111,7 +111,8 @@ define(function (require, exports, module) {
     }
 
     /**
-     * Adds resizing capabilities to a given html element.
+     * Adds resizing and (optionally) expand/collapse capabilities to a given html element. The element's size
+     * & visibility are automatically saved & restored as a view-state preference.
      *
      * Resizing can be configured in two directions:
      *  - Vertical ("vert"): Resizes the height of the element
@@ -130,7 +131,8 @@ define(function (require, exports, module) {
      *  - panelExpanded: When the panel gets expanded (or shown). Passed the initial size.
      *      May occur without any resize events.
      *
-     * @param {!DOMNode} element DOM element which should be made resizable. Must have an id attribute.
+     * @param {!DOMNode} element DOM element which should be made resizable. Must have an id attribute, for
+     *                          use as a preferences key.
      * @param {!string} direction Direction of the resize action: one of the DIRECTION_* constants.
      * @param {!string} position Which side of the element can be dragged: one of the POSITION_* constants
      *                          (TOP/BOTTOM for vertical resizing or LEFT/RIGHT for horizontal).

src/view/PanelManager.js

@@ -183,10 +183,12 @@ define(function (require, exports, module) {
 
 
     /**
-     * Creates a new panel beneath the editor area and above the status bar footer. Panel is initially invisible.
+     * Creates a new resizabel panel beneath the editor area and above the status bar footer. Panel is initially invisible.
+     * The panel's size & visibility are automatically saved & restored as a view-state preference.
      * 
      * @param {!string} id  Unique id for this panel. Use package-style naming, e.g. "myextension.feature.panelname"
-     * @param {!jQueryObject} $panel  DOM content to use as the panel. Need not be in the document yet. Must have an id.
+     * @param {!jQueryObject} $panel  DOM content to use as the panel. Need not be in the document yet. Must have an id
+     *      attribute, for use as a preferences key.
      * @param {number=} minSize  Minimum height of panel in px.
      * @return {!Panel}
      */