JSDoc for #49

phetsims · Mar 6, 2018 · 1858868 · 1858868
1 parent 4b34f22
commit 1858868
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/js/gravity-force-lab-basics/view/GravityForceLabBasicsKeyboardHelpContent.js b/js/gravity-force-lab-basics/view/GravityForceLabBasicsKeyboardHelpContent.js
@@ -133,14 +133,15 @@ define( function( require ) {
   return inherit( Panel, GravityForceLabBasicsKeyboardHelpContent, {
 
     /**
-     * Works like this.constructRow( 'jump to the end', 'end' );
-     * @param  {[type]} labelString [description]
-     * @param  {[type]} iconOption  [description]
-     * @return {[type]}             [description]
+     * Construct a row for the help dialog, assembling a label with an icon using Helpcontent. Usages will look like:
+     * this.constructRow( 'jump to the end', 'end' );
+     * 
+     * @param  {string} labelString - the text label for the row (visual)
+     * @param  {string} iconOption - must be one of the keys in ICON_OPTIONS
+     * @return {Object} - {label: Node, icon: Node}, return value of HelpContent.labelWithIcon 
      */
     constructRow: function( labelString, iconOption ) {
       var labelNode = new RichText( labelString, DEFAULT_LABEL_OPTIONS );
-
       var iconNode = ICON_OPTIONS[ iconOption ]();
 
       return HelpContent.labelWithIcon( labelNode, iconNode );