From 1858868a3a902bd6778f89fe728b7ef2fc073e64 Mon Sep 17 00:00:00 2001 From: Jesse Greenberg Date: Tue, 6 Mar 2018 15:56:12 -0700 Subject: [PATCH] JSDoc for #49 --- .../view/GravityForceLabBasicsKeyboardHelpContent.js | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/js/gravity-force-lab-basics/view/GravityForceLabBasicsKeyboardHelpContent.js b/js/gravity-force-lab-basics/view/GravityForceLabBasicsKeyboardHelpContent.js index 65b6231..b162514 100644 --- 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 );