diff --git a/js/balloons-and-static-electricity/model/BASEModel.js b/js/balloons-and-static-electricity/model/BASEModel.js index 46b4823d..23902964 100644 --- a/js/balloons-and-static-electricity/model/BASEModel.js +++ b/js/balloons-and-static-electricity/model/BASEModel.js @@ -144,7 +144,7 @@ define( function( require ) { * Return true when both balloons are visible. * @public * - * @return {boolean} + * @returns {boolean} */ bothBalloonsVisible: function() { return this.greenBalloon.isVisibleProperty.get() && this.yellowBalloon.isVisibleProperty.get(); @@ -153,7 +153,7 @@ define( function( require ) { /** * Returns true when both balloons are visible and adjacent to each other. * - * @return {boolean} + * @returns {boolean} */ getBalloonsAdjacent: function() { var balloonsAdjacent = ( this.yellowBalloon.getCenter().minus( this.greenBalloon.getCenter() ).magnitude() ) < BalloonModel.BALLOON_WIDTH; @@ -167,7 +167,7 @@ define( function( require ) { * @param {number} objWidth - width of balloon * @param {number} objHeight - height of balloon * - * @return {[type]} [description] + * @returns {[type]} [description] */ checkBalloonRestrictions: function( position, objWidth, objHeight ) { @@ -209,7 +209,7 @@ define( function( require ) { /** * Get the distance between the two balloons. * - * @return {number} + * @returns {number} */ getDistance: function() { return this.greenBalloon.getCenter().distance( this.yellowBalloon.getCenter() ); diff --git a/js/balloons-and-static-electricity/model/BalloonDirectionEnum.js b/js/balloons-and-static-electricity/model/BalloonDirectionEnum.js index bb3b6c8e..258d532a 100644 --- a/js/balloons-and-static-electricity/model/BalloonDirectionEnum.js +++ b/js/balloons-and-static-electricity/model/BalloonDirectionEnum.js @@ -26,7 +26,7 @@ define( function( require ) { * Returns true if direction is one of the primary relative directions "up", "down", "left", "right". * * @param {string} direction - one of BalloonDirectionEnum - * @return {Boolean} + * @returns {Boolean} */ isRelativeDirection: function( direction ) { return direction === BalloonDirectionEnum.LEFT || diff --git a/js/balloons-and-static-electricity/model/BalloonModel.js b/js/balloons-and-static-electricity/model/BalloonModel.js index b327c908..f8ec43dc 100644 --- a/js/balloons-and-static-electricity/model/BalloonModel.js +++ b/js/balloons-and-static-electricity/model/BalloonModel.js @@ -374,7 +374,7 @@ define( function( require ) { * balloon or wall visibility. Useful for checking whether the balloon is at the wall location * when the wall is removed. * - * @return {boolean} + * @returns {boolean} */ rightAtWallLocation: function() { return this.getCenterX() === PlayAreaMap.X_LOCATIONS.AT_WALL; @@ -383,7 +383,7 @@ define( function( require ) { /** * Returns whether or not this balloon is at the right edge of the play area. * - * @return {boolean} + * @returns {boolean} */ atRightEdge: function() { return this.getCenterX() === PlayAreaMap.X_BOUNDARY_LOCATIONS.AT_WALL; @@ -392,7 +392,7 @@ define( function( require ) { /** * Returns whether or not this balloon is at the left edge of the play area. * - * @return {string} + * @returns {string} */ atLeftEdge: function() { return this.getCenterX() === PlayAreaMap.X_BOUNDARY_LOCATIONS.AT_LEFT_EDGE; @@ -402,7 +402,7 @@ define( function( require ) { * Returns whether or not this balloon is in the center of the play area horizontally. Does not consider vertical * location. * - * @return {boolean} + * @returns {boolean} */ inCenterPlayArea: function() { return PlayAreaMap.COLUMN_RANGES.CENTER_PLAY_AREA.contains( this.getCenterX() ); @@ -412,7 +412,7 @@ define( function( require ) { * Returns whether or not the balloon is very close to an object in the play area. Will return true if the center * is withing one of the "very close" ranges in the play area. * - * @return {string} + * @returns {string} */ veryCloseToObject: function() { var centerX = this.getCenterX(); @@ -435,7 +435,7 @@ define( function( require ) { /** * Returns true if the balloon is moving horizontally, left or right. * @public - * @return {string} - "LEFT"|"RIGHT" + * @returns {string} - "LEFT"|"RIGHT" */ movingHorizontally: function() { var direction = this.directionProperty.get(); @@ -445,7 +445,7 @@ define( function( require ) { /** * Returns true if the balloon is movingv vertically, up or down * @public - * @return {string} - "UP"|"DOWN" + * @returns {string} - "UP"|"DOWN" */ movingVertically: function() { var direction = this.directionProperty.get(); @@ -455,7 +455,7 @@ define( function( require ) { /** * Returns true if the balloon is moving horizontally, left or right. * @public - * @return {string} - "UP_LEFT"|"UP_RIGHT"|"DOWN_LEFT"|"DOWN_RIGHT" + * @returns {string} - "UP_LEFT"|"UP_RIGHT"|"DOWN_LEFT"|"DOWN_RIGHT" */ movingDiagonally: function() { var direction = this.directionProperty.get(); @@ -468,7 +468,7 @@ define( function( require ) { /** * Get whether or not the balloon is s moving to the right. * - * @return {boolean} + * @returns {boolean} */ movingRight: function() { var direction = this.directionProperty.get(); @@ -480,7 +480,7 @@ define( function( require ) { /** * Get whether or not the balloon is moving to the left. * - * @return {boolean} + * @returns {boolean} */ movingLeft: function() { var direction = this.directionProperty.get(); @@ -495,7 +495,7 @@ define( function( require ) { * horizontally, progress will be proportion of width. If moving vertically, progress will be * a proportion of the height. * - * @return {number} + * @returns {number} */ getProgressThroughRegion: function() { @@ -547,7 +547,7 @@ define( function( require ) { /** * Get the vertical center of the balloon model. - * @return {number} + * @returns {number} */ getCenterY: function() { return this.locationProperty.get().y + this.height / 2; @@ -555,7 +555,7 @@ define( function( require ) { /** * Get the horizontal center location of the balloon. - * @return {number} + * @returns {number} */ getCenterX: function() { return this.locationProperty.get().x + this.width / 2; @@ -564,7 +564,7 @@ define( function( require ) { /** * Get the right edge of the balloon. * - * @return {number} + * @returns {number} */ getRight: function() { return this.locationProperty.get().x + this.width; @@ -577,7 +577,7 @@ define( function( require ) { * balloon plus the average y position of the charges. * * @public - * @return {Vector2} + * @returns {Vector2} */ getChargeCenter: function() { var centerX = this.getCenter().x; @@ -589,7 +589,7 @@ define( function( require ) { * Get the position of the left touch point of the balloon against the sweater. If the balloon center is to the * right of the sweater edge, use the left edge of the balloon. Otherwise, use the balloon center. * - * @return {Vector2} + * @returns {Vector2} */ getSweaterTouchingCenter: function() { var sweater = this.balloonsAndStaticElectricityModel.sweater; @@ -608,7 +608,7 @@ define( function( require ) { /** * Returns whether or not this balloon has any charge. Just a helper function for convenience and readability. * @public - * @return {boolean} + * @returns {boolean} */ isCharged: function() { @@ -619,7 +619,7 @@ define( function( require ) { /** * Returns true if this balloon is both inducing charge and visible. Helper function for readability. * @public - * @return {boolean} + * @returns {boolean} */ inducingChargeAndVisible: function() { return this.isVisibleProperty.get() && this.inducingChargeProperty.get(); @@ -629,7 +629,7 @@ define( function( require ) { * Whether this balloon is inducing charge in the wall. For the balloon to be inducing charge in the wall, this * balloon must be visible, the wall must be visible, and the force between wall and balloon must be large enough. * - * @return {boolean} + * @returns {boolean} */ inducingCharge: function( wallVisible ) { @@ -764,7 +764,7 @@ define( function( require ) { /** * Returns whether or not the balloon is touching the boundary of the play area, including the bottom, left * and top edges, or the right edge or wall depending on wall visibility. - * @return {string} + * @returns {string} */ isTouchingBoundary: function() { return this.isTouchingRightBoundary() || this.isTouchingLeftBoundary() || @@ -776,7 +776,7 @@ define( function( require ) { * is visible, this will be the location where the balloon is touching the wall, otherwise it will * be the location where the balloon is touching the right edge of the play area. * - * @return {boolean} + * @returns {boolean} */ isTouchingRightBoundary: function() { var balloonX = this.getCenter().x; @@ -792,7 +792,7 @@ define( function( require ) { * Returns whether or not the balloon is touching the right most edge of the play area (should be impossible * if the wall is invisible) * - * @return {boolean} + * @returns {boolean} */ isTouchingRightEdge: function() { var balloonX = this.getCenterX(); @@ -801,7 +801,7 @@ define( function( require ) { /** * Returns whether or not the balloon is touching the bottom boundary of the play area. - * @return {boolean} + * @returns {boolean} */ isTouchingBottomBoundary: function() { return PlayAreaMap.Y_BOUNDARY_LOCATIONS.AT_BOTTOM === this.getCenterY(); @@ -814,7 +814,7 @@ define( function( require ) { /** * Returns whether or not the balloon is touching the top boundary of the play area. * - * @return {boolean} + * @returns {boolean} */ isTouchingTopBoundary: function() { return PlayAreaMap.Y_BOUNDARY_LOCATIONS.AT_TOP === this.getCenterY(); @@ -967,7 +967,7 @@ define( function( require ) { * Get the force on a balloon from the closest charge to the balloon in the wall. * * @param {BalloonModel} balloon - * @return {Vector2} + * @returns {Vector2} */ getForceToClosestWallCharge: function( balloon ) { return BalloonModel.getForce( @@ -985,7 +985,7 @@ define( function( require ) { * * @param {Vector2} pointA * @param {Vector2} pointB - * @return {string} - one of BalloonDirectionEnum + * @returns {string} - one of BalloonDirectionEnum * @static */ getDirection: function( pointA, pointB ) { diff --git a/js/balloons-and-static-electricity/model/MovablePointChargeModel.js b/js/balloons-and-static-electricity/model/MovablePointChargeModel.js index 7d1eade6..d2f1f673 100644 --- a/js/balloons-and-static-electricity/model/MovablePointChargeModel.js +++ b/js/balloons-and-static-electricity/model/MovablePointChargeModel.js @@ -57,7 +57,7 @@ define( function( require ) { /** * Get the displacement of the charge from its initial position. Useful as a measure of the induced charge. * - * @return {Vector2} + * @returns {Vector2} */ getDisplacement: function() { var initialPosition = this.locationProperty.initialValue; diff --git a/js/balloons-and-static-electricity/model/PlayAreaMap.js b/js/balloons-and-static-electricity/model/PlayAreaMap.js index a2993202..a55e627d 100644 --- a/js/balloons-and-static-electricity/model/PlayAreaMap.js +++ b/js/balloons-and-static-electricity/model/PlayAreaMap.js @@ -126,7 +126,7 @@ define( function( require ) { * Get the column of the play area for the a given location in the model, including landmark locations. * * @param {Vector2} location - * @return {string} + * @returns {string} */ getPlayAreaColumn: function( location, wallVisible ) { var columns = COLUMN_RANGES; @@ -155,7 +155,7 @@ define( function( require ) { * Get the landmark of the play area for the a given location in the model. * * @param {Vector2} location - * @return {string} + * @returns {string} */ getPlayAreaLandmark: function( location, wallVisible ) { var landmarks = LANDMARK_RANGES; @@ -182,8 +182,8 @@ define( function( require ) { /** * Get a row in the play area that contains the location in the model. * - * @param {Vector2} location - * @return {strint} + * @param {Vector2} location + * @returns {strint} */ getPlayAreaRow: function( location ) { var rows = PlayAreaMap.ROW_RANGES; @@ -208,7 +208,7 @@ define( function( require ) { * that surround critical x locations. * * @param {Vector2s} location - * @return {boolean} + * @returns {boolean} */ inLandmarkColumn: function( location ) { var landmarks = PlayAreaMap.LANDMARK_RANGES; @@ -236,7 +236,7 @@ define( function( require ) { * @param {number} width - desired width of the next range * @param {Range} [previousRange] - if provided, next range will start from max of this range * - * @return {Range} + * @returns {Range} */ function createNextRange( width, previousRange ) { var min = previousRange ? previousRange.max : 0; @@ -249,7 +249,7 @@ define( function( require ) { * PlayArea that define how the balloon's location should be described. * * @param {number} xLocation - center of the landmark - * @return {Range} + * @returns {Range} */ function createLandmarkRange( xLocation ) { return new Range( xLocation - HALF_LANDMARK_WIDTH, xLocation + HALF_LANDMARK_WIDTH ); diff --git a/js/balloons-and-static-electricity/model/WallModel.js b/js/balloons-and-static-electricity/model/WallModel.js index 4c800fa0..a6645f9e 100644 --- a/js/balloons-and-static-electricity/model/WallModel.js +++ b/js/balloons-and-static-electricity/model/WallModel.js @@ -156,7 +156,7 @@ define( function( require ) { * @param {number} i - column number * @param {number} k - row number * - * @return {Array.} - an array containing the x and y values for the charge + * @returns {Array.} - an array containing the x and y values for the charge */ calculatePosition: function( i, k ) { var y0 = i % 2 === 0 ? this.dy / 2 : 1; @@ -166,8 +166,8 @@ define( function( require ) { /** * Get the minus charge that is the closest in the wall to the balloon, relative to the charge's initial * position. - * - * @return {MovablePointChargeModel} + * + * @returns {MovablePointChargeModel} */ getClosestChargeToBalloon: function( balloon ) { var minusCharges = this.minusCharges; @@ -197,7 +197,7 @@ define( function( require ) { * @public * * @param {Vector2} force - force applied on this charge - * @return {boolean} + * @returns {boolean} */ forceIndicatesInducedCharge: function( force ) { return force.magnitude() > FORCE_MAGNITUDE_THRESHOLD; diff --git a/js/balloons-and-static-electricity/view/BASEKeyboardHelpContent.js b/js/balloons-and-static-electricity/view/BASEKeyboardHelpContent.js index 1c1dd7f8..b8019235 100644 --- a/js/balloons-and-static-electricity/view/BASEKeyboardHelpContent.js +++ b/js/balloons-and-static-electricity/view/BASEKeyboardHelpContent.js @@ -154,7 +154,7 @@ define( function( require ) { * @param {string} keyString - the letter name that will come after 'j' * @param {string} labelString * @param {string} innerContent - * @return {HBox} + * @returns {HBox} */ function createJumpKeyRow( keyString, labelString, innerContent ) { diff --git a/js/balloons-and-static-electricity/view/BASESummaryNode.js b/js/balloons-and-static-electricity/view/BASESummaryNode.js index dc7dcfce..dc65faa8 100644 --- a/js/balloons-and-static-electricity/view/BASESummaryNode.js +++ b/js/balloons-and-static-electricity/view/BASESummaryNode.js @@ -160,7 +160,7 @@ define( function( require ) { * "Sweater has positive net charge, showing several positive charges. Wall has zero net charge, showing several * positive charges." * - * @return {string} + * @returns {string} */ getSweaterAndWallChargeDescription: function() { var description; @@ -211,7 +211,7 @@ define( function( require ) { * "Yellow balloon has negative net charge, a few more negative charges than positive charges." or * “Yellow balloon has negative net charge, several more negative charges than positive charges. Green balloon has negative net charge, a few more negative charges than positive charges. Yellow balloon has negative net charge, showing several negative charges. Green balloon has negative net charge, showing a few negative charges.” * - * @return {string} + * @returns {string} */ getBalloonChargeDescription: function() { var description; @@ -269,7 +269,7 @@ define( function( require ) { * "Negative charges in wall move away from balloons quite a lot. Positive charges do not move." or * "Negative charges in wall move away from Green Balloon a little bit. Positive charges do not move." * - * @return {string} + * @returns {string} */ getInducedChargeDescription: function() { var description; @@ -348,7 +348,7 @@ define( function( require ) { * @private * @param {Property.} balloonVisible * @param {Property.} wallVisible - * @return {string} + * @returns {string} */ getVisibleObjectsDescription: function( balloonVisible, wallVisible ) { var patternString; diff --git a/js/balloons-and-static-electricity/view/BalloonInteractionCueNode.js b/js/balloons-and-static-electricity/view/BalloonInteractionCueNode.js index 617d94b5..a4487c3f 100644 --- a/js/balloons-and-static-electricity/view/BalloonInteractionCueNode.js +++ b/js/balloons-and-static-electricity/view/BalloonInteractionCueNode.js @@ -101,7 +101,7 @@ define( function( require ) { * would move if that key is pressed. * * @param {string} direction - 'up'|'down'|'left'|'right' - * @return {Node} + * @returns {Node} */ createMovementKeyNode: function( direction ) { diff --git a/js/balloons-and-static-electricity/view/BalloonNode.js b/js/balloons-and-static-electricity/view/BalloonNode.js index a3e6b06a..e30241a5 100644 --- a/js/balloons-and-static-electricity/view/BalloonNode.js +++ b/js/balloons-and-static-electricity/view/BalloonNode.js @@ -367,7 +367,7 @@ define( function( require ) { /** * Determine if the user attempted to move beyond the play area bounds with the keyboard. - * @return {[type]} [description] + * @returns {[type]} [description] */ attemptToMoveBeyondBoundary: function( keyCode ) { return ( diff --git a/js/balloons-and-static-electricity/view/describers/BASEDescriber.js b/js/balloons-and-static-electricity/view/describers/BASEDescriber.js index ce14cd76..6f1e50f9 100644 --- a/js/balloons-and-static-electricity/view/describers/BASEDescriber.js +++ b/js/balloons-and-static-electricity/view/describers/BASEDescriber.js @@ -200,7 +200,7 @@ define( function( require ) { * @param {Object[]} [entries] - Additional entries to add to the mapped value range, will look something like * { description: {string}, range: {Range} } * - * @return {Object} + * @returns {Object} */ var generateDescriptionMapWithEntries = function( descriptionArray, valueRange, entries ) { entries = entries || []; @@ -257,7 +257,7 @@ define( function( require ) { * descsription. Regions are defined in PlayAreaMap. This will get called very often and needs to be quick. * * @param {Vector2} location - location of the balloon, relative to its center - * @return {string} + * @returns {string} */ getLocationDescription: function( location, wallVisible ) { @@ -326,7 +326,7 @@ define( function( require ) { * @private * * @param {string} column - one of keys in LOCATION_DESCRIPTION_MAP - * @return {boolean} + * @returns {boolean} */ inWallColumn: function( column ) { return ( column === 'AT_WALL' || column === 'AT_NEAR_WALL' || column === 'WALL' || column === 'AT_VERY_CLOSE_TO_WALL' ); @@ -337,7 +337,7 @@ define( function( require ) { * string patterns * * @param {number} charge - * @return {string} + * @returns {string} */ getRelativeChargeDescription: function( charge ) { @@ -364,7 +364,7 @@ define( function( require ) { * a charge pickup. Descriptions are generated relative to the absolute value of the charge. * * @param {number} charge - * @return {Range} + * @returns {Range} */ getDescribedChargeRange: function( charge ) { @@ -390,7 +390,7 @@ define( function( require ) { * @param {BalloonModel} balloonA * @param {BalloonModel} balloonB * - * @return {[type]} [description] + * @returns {[type]} [description] */ getBalloonsVisibleWithSameChargeRange: function( balloonA, balloonB ) { var rangeA = BASEDescriber.getDescribedChargeRange( balloonA.chargeProperty.get() ); @@ -407,7 +407,7 @@ define( function( require ) { * @public * * @param {string} direction - one of BalloonDirectionEnum - * @return {string} + * @returns {string} */ getDirectionDescription: function( direction ) { return DIRECTION_MAP[ direction ]; @@ -419,7 +419,7 @@ define( function( require ) { * "Each balloon has negative net charge." or * "Each balloon has zero net charge." * - * @return {string} + * @returns {string} */ getNetChargeDescriptionWithLabel: function( charge ) { var chargeAmountString = charge < 0 ? negativeString : zeroString; @@ -438,7 +438,7 @@ define( function( require ) { * * @param {string} chargesShown * @param {number} numberOfCharges - * @return {string} + * @returns {string} */ getNeutralChargesShownDescription: function( chargesShown, numberOfCharges ) { var description; diff --git a/js/balloons-and-static-electricity/view/describers/BalloonChargeDescriber.js b/js/balloons-and-static-electricity/view/describers/BalloonChargeDescriber.js index 708f1612..e85f5842 100644 --- a/js/balloons-and-static-electricity/view/describers/BalloonChargeDescriber.js +++ b/js/balloons-and-static-electricity/view/describers/BalloonChargeDescriber.js @@ -104,7 +104,7 @@ define( function( require ) { * "Has negative net charge." or * "Has neutral net charge." * - * @return {string} + * @returns {string} */ getNetChargeDescription: function() { var chargeAmountString = this.balloonModel.chargeProperty.get() < 0 ? balloonNegativeString : balloonZeroString; @@ -118,7 +118,7 @@ define( function( require ) { * "Yellow balloon has negative net charge." or * "Green balloon has no net charge." * - * @return {string} + * @returns {string} */ getNetChargeDescriptionWithLabel: function() { var chargeAmountString = this.balloonModel.chargeProperty.get() < 0 ? balloonNegativeString : balloonZeroString; @@ -138,7 +138,7 @@ define( function( require ) { * "Green balloon has several more negative charges than positive charges. Yellow balloon has several more * negative charges than positive charges." or * - * @return {string} + * @returns {string} */ getCombinedRelativeChargeDescription: function() { assert && assert( this.balloonModel.isDraggedProperty.get(), 'alert should only be generated if balloon is grabbed' ); @@ -180,7 +180,7 @@ define( function( require ) { * Get a description of the induced charge in the wall or the charge of the sweater. To be used by the "grab" alert * when the balloon is picked up. * - * @return {string} + * @returns {string} */ getOtherObjectChargeDescription: function() { var inducingChargeOrTouchingWall = this.balloonModel.inducingChargeProperty.get() || this.balloonModel.touchingWall(); @@ -249,7 +249,7 @@ define( function( require ) { * "Negative charges in wall begin to return." * "Negative charges in wall return a little more." * - * @return {string} + * @returns {string} */ getInducedChargeChangeDescription: function() { var descriptionString; @@ -324,7 +324,7 @@ define( function( require ) { * that the charges moved away from the balloon, we will always describe the return of induced charges at least * once. * - * @return {string} + * @returns {string} */ describeInducedChargeChange: function() { var chargesShown = this.showChargesProperty.get(); @@ -340,7 +340,7 @@ define( function( require ) { /** * A description of the balloon's relative charge but modified slightly for the context of the screen summary. * - * @return {string} + * @returns {string} */ getSummaryRelativeChargeDescription: function() { var chargesShown = this.showChargesProperty.get(); @@ -359,7 +359,7 @@ define( function( require ) { * "Has zero net charge, showing no charges." or * "Has zero net charge, many pairs of positive and negative charges" * - * @return {string} + * @returns {string} */ getHasRelativeChargeDescription: function() { var balloonCharge = this.balloonModel.chargeProperty.get(); @@ -405,7 +405,7 @@ define( function( require ) { * @param {BalloonModel} balloonModel * @param {string} showCharges - one of 'all', 'none, 'diff' * - * @return {string} + * @returns {string} */ getRelativeChargeDescription: function( balloonModel, showCharges ) { var description; @@ -442,8 +442,8 @@ define( function( require ) { * "Yellow balloon has zero net charge, showing no charges." * * Dependent on the charge view. - * - * @return {string} + * + * @returns {string} */ getRelativeChargeDescriptionWithLabel: function( balloonModel, showCharges, label ) { var description; diff --git a/js/balloons-and-static-electricity/view/describers/BalloonDescriber.js b/js/balloons-and-static-electricity/view/describers/BalloonDescriber.js index b9c7642b..0daa3f9e 100644 --- a/js/balloons-and-static-electricity/view/describers/BalloonDescriber.js +++ b/js/balloons-and-static-electricity/view/describers/BalloonDescriber.js @@ -269,7 +269,7 @@ define( function( require ) { * "At center of play area. Has zero net charge, no more negative charge than positive charges." or * "At center of play area, next to green balloon." * - * @return {string} + * @returns {string} */ getBalloonDescription: function() { var description; @@ -307,7 +307,7 @@ define( function( require ) { * sweater, and the number of charges that the balloon has picked up. * * @param {boolean} firstPickup - special behavior if the first charge pickup since landing on sweater - * @return {string} + * @returns {string} */ getChargePickupDescription: function( firstPickup ) { var description; @@ -376,7 +376,7 @@ define( function( require ) { * area, we get an initial alert like * "Yellow Balloon picks up negative charges from sweater." * - * @return {string} + * @returns {string} */ getInitialChargePickupDescription: function() { var description; @@ -410,7 +410,7 @@ define( function( require ) { * "No change in charges. On right side of sweater. Sweater has positive net charge. Yellow Balloon has negative * net charge. Press space to release." * - * @return {string} + * @returns {string} */ getNoChargePickupDescription: function() { var alert; @@ -484,7 +484,7 @@ define( function( require ) { * "At upper wall." or * "At lower wall. Yellow balloon has negative net charge, showing several more negative charges than positive charges." * - * @return {string} + * @returns {string} */ getWallRubbingDescription: function() { var descriptionString; @@ -600,7 +600,7 @@ define( function( require ) { * "At upper wall. No transfer of charge. In upper wall, no change in charges. Wall has many pairs of negative * and positive charges." * - * @return {string} + * @returns {string} */ getWallRubbingDescriptionWithChargePairs: function() { return StringUtils.fillIn( wallRubbingWithPairsPattern, { @@ -612,7 +612,7 @@ define( function( require ) { * Get the description when the balloon has picked up the last charge on the sweater. * Dependent on the charge view. * - * @return {string} + * @returns {string} */ getLastChargePickupDescription: function() { var shownCharges = this.showChargesProperty.get(); @@ -634,7 +634,7 @@ define( function( require ) { * "Green balloon added. Sticking to left shoulder of sweater." or * "Green balloon added. On left side of play area, next to yellow balloon." * - * @return {string} + * @returns {string} */ getVisibilityChangedDescription: function() { var description; diff --git a/js/balloons-and-static-electricity/view/describers/BalloonLocationDescriber.js b/js/balloons-and-static-electricity/view/describers/BalloonLocationDescriber.js index 7a124f49..bfa7045a 100644 --- a/js/balloons-and-static-electricity/view/describers/BalloonLocationDescriber.js +++ b/js/balloons-and-static-electricity/view/describers/BalloonLocationDescriber.js @@ -169,8 +169,8 @@ define( function( require ) { /** * Get a description that describes the attractive state or proximity of the balloon, such as * "On...", "sticking to...", "Near..." and so on. - * - * @return {string} + * + * @returns {string} */ getAttractiveStateOrProximityDescription: function() { var string = ''; @@ -198,8 +198,8 @@ define( function( require ) { * or location of balloon. * * NOTE: This function is undoubtedly horrible for i18n. - * - * @return {string} + * + * @returns {string} */ getPreposition: function() { var string = ''; @@ -238,8 +238,8 @@ define( function( require ) { * Returns a string that combines the balloon's attractive state and location descriptions. Something * like "On center of play area" or "Sticking to wall". This fragment is used in a number of different * contexts, so it doesn't include punctuation at the end. - * - * @return {string} + * + * @returns {string} */ getAttractiveStateAndLocationDescription: function() { var locationDescriptionString = this.getBalloonLocationDescription(); @@ -258,7 +258,7 @@ define( function( require ) { * Returns something like: * Yellow balloon, sticking to right arm of sweater. * - * @return {string} + * @returns {string} */ getAttractiveStateAndLocationDescriptionWithLabel: function() { var alert; @@ -279,8 +279,8 @@ define( function( require ) { * Get a description of the balloon being "on" an item in the play area. Instead of getting * the attractive state of the balloon (like 'touching' or 'sticking' or 'near'), simply say * 'on' wherever the balloon is. - * - * @return {string} + * + * @returns {string} */ getOnLocationDescription: function() { @@ -302,8 +302,8 @@ define( function( require ) { * "upper wall", or * "wall, next to Green Balloon", or * "right arm of sweater, next to Yellow Balloon" - * - * @return {string} + * + * @returns {string} */ getBalloonLocationDescription: function() { var description = this.getLocationDescriptionWithoutOverlap(); @@ -327,7 +327,7 @@ define( function( require ) { * * any of the other location descriptions for the PlayAreaMap. * - * @return {string} + * @returns {string} */ getLocationDescriptionWithoutOverlap: function() { var describedBalloonPosition = this.getDescribedPoint(); @@ -339,8 +339,8 @@ define( function( require ) { * Get the point on the balloon that should be described. Generally, this is the balloon center. If the balloon * is touching the sweater or the wall, the point of touching should be described. If near the wall, the described * point is the edge of the wall to accomplish a description like "Yellow balloon, Near upper wall". - * - * @return {Vector2} + * + * @returns {Vector2} */ getDescribedPoint: function() { var describedBalloonPosition; @@ -359,8 +359,8 @@ define( function( require ) { /** * Get a short description of the balloon's location at a boundary when there is an attempted drag beyond * the boundary. Will return something like "At bottom" or "At top". - * - * @return {string} + * + * @returns {string} */ getTouchingBoundaryDescription: function( attemptedDirection ) { assert && assert ( this.balloonModel.isTouchingBoundary(), 'balloon is not touching a boundary' ); @@ -394,7 +394,7 @@ define( function( require ) { * "Off sweater" * * @param {boolean} onSweater - * @return {string} + * @returns {string} */ getOnSweaterString: function( onSweater ) { var description; @@ -428,7 +428,7 @@ define( function( require ) { * drag velocity, and movement direction. Depending on these variables, we might not announce this alert, so * this function can return null. * - * @return {string|null} + * @returns {string|null} */ getLandmarkDragDescription: function() { var playAreaLandmark = this.balloonModel.playAreaLandmarkProperty.get(); @@ -463,7 +463,7 @@ define( function( require ) { * "At center of play area." or * "Closer to sweater." * - * @return {string} + * @returns {string} */ getKeyboardMovementAlert: function() { var alert; @@ -502,7 +502,7 @@ define( function( require ) { * * @param {Vector2} location - the current location of the balloon * @param {Vector2} oldLocation - the previous location of the balloon - * @return {string} + * @returns {string} */ getInitialReleaseDescription: function( location, oldLocation ) { @@ -534,8 +534,8 @@ define( function( require ) { * Will return something like * "Moving Left." or * "Moving Left. Near wall." - * - * @return {string} + * + * @returns {string} */ getContinuousReleaseDescription: function() { var description; @@ -571,8 +571,8 @@ define( function( require ) { * are visible, we include information about the induced charge in the wall. Will return something like * "No change in position. Yellow balloon, on left side of Play Area." or * "No change in position. Yellow Balloon, at wall. Negative charges in wall move away from yellow balloon a lot." - * - * @return {string} + * + * @returns {string} */ getNoChangeReleaseDescription: function() { var description; @@ -623,7 +623,7 @@ define( function( require ) { * Get a description of velocity for this balloon, one of "very slowly", "slowly", "quickly", "very quickly" * * @private - * @return {string} + * @returns {string} */ getVelocityString: function() { var velocityString; @@ -649,7 +649,7 @@ define( function( require ) { * is one of BalloonDirectionEnum. * * @param {string} direction - one of BalloonDirectionEnum - * @return {string} + * @returns {string} */ getDraggingDirectionDescription: function( direction ) { var movementString = BALLOON_DIRECTION_DRAGGING_MAP[ direction ]; @@ -674,8 +674,8 @@ define( function( require ) { /** * Get the dragging description while the balloon is moving through the play area being dragged and enters * a new region in the play area. - * - * @return {string} + * + * @returns {string} */ getPlayAreaDragNewRegionDescription: function() { @@ -693,8 +693,8 @@ define( function( require ) { /** * Get a progress string toward the sweater, wall, top edge, bottom edge, or center of play area. - * - * @return {string} + * + * @returns {string} */ getPlayAreaDragProgressDescription: function() { var alert; @@ -752,7 +752,7 @@ define( function( require ) { * "Left." or * "Now Left." * - * @return {string} + * @returns {string} */ getDirectionChangedDescription: function() { var description; @@ -792,7 +792,7 @@ define( function( require ) { * "Green balloon, at wall. Negative charges in wall move away from yellow balloon a little bit." * '' * - * @return {string} + * @returns {string} */ getMovementStopsDescription: function() { var descriptionString; @@ -831,7 +831,7 @@ define( function( require ) { * for the movement to be observable. This is to prevent this alert from firing indefinitely if the balloon has * some arbitrary velocity. * - * @return {boolean} + * @returns {boolean} */ balloonMovingAtContinousDescriptionVelocity: function() { var velocityMagnitude = this.balloonModel.velocityProperty.get().magnitude(); @@ -846,8 +846,8 @@ define( function( require ) { * setting. If the balloon is inducing charge, information about induced charge will be included. * If the balloon is on the sweater, will include infomation about the charges on the sweater. After the * balloon has been picked up once, we don't need to describe help information until reset. - * - * @return {string} + * + * @returns {string} */ getGrabbedAlert: function() { var description; @@ -921,7 +921,7 @@ define( function( require ) { * * @public * @param {Vector2} center - * @return {string} + * @returns {string} */ getJumpingDescription: function( center ) { var description = ''; diff --git a/js/balloons-and-static-electricity/view/describers/SweaterDescriber.js b/js/balloons-and-static-electricity/view/describers/SweaterDescriber.js index 93c0b200..88e87b07 100644 --- a/js/balloons-and-static-electricity/view/describers/SweaterDescriber.js +++ b/js/balloons-and-static-electricity/view/describers/SweaterDescriber.js @@ -73,7 +73,7 @@ define( function( require ) { * "At left edge of Play Area. Has positive net charge, several more positive charges than negative charges." * * @param {Property.} showCharges - * @return {string} + * @returns {string} */ getSweaterDescription: function( showCharges ) { var description; @@ -152,7 +152,7 @@ define( function( require ) { * * @param {number} charge * @param {string} shownCharges - * @return {string} + * @returns {string} */ getRelativeChargeDescriptionWithLabel: function( charge, shownCharges ) { var description; @@ -200,7 +200,7 @@ define( function( require ) { * word to indicate this. * * @param {number} charge - * @return {string} + * @returns {string} */ getRelativeChargeDescription: function( charge ) { @@ -217,7 +217,7 @@ define( function( require ) { * charge visibility. * * @param {string} shownCharges - * @return {string} + * @returns {string} */ getNoMoreChargesAlert: function( charge, shownCharges ) { var alert; @@ -239,7 +239,7 @@ define( function( require ) { * "Sweater has neutral net charge." * * @param {number} sweaterCharge - * @return {string} + * @returns {string} */ getNetChargeDescription: function( sweaterCharge ) { var relativeChargeString = ( sweaterCharge === 0 ) ? neutralNetChargeString : positiveNetChargeString; @@ -257,7 +257,7 @@ define( function( require ) { * * @param {BalloonModel} balloon * @param {string} shownCharges - * @return {string} + * @returns {string} */ getMoreChargesDescription: function( balloon, sweaterCharge, sweaterCharges, shownCharges ) { assert && assert( sweaterCharge < BASEConstants.MAX_BALLOON_CHARGE, 'no more charges on sweater' ); @@ -299,7 +299,7 @@ define( function( require ) { * "Sweater has zero net charge, many pairs of positive and negative charges." * "Sweater has zero net charge, showing no charges." * - * @return {string} + * @returns {string} */ getSummaryChargeDescription: function( chargesShown, charge ) { diff --git a/js/balloons-and-static-electricity/view/describers/WallDescriber.js b/js/balloons-and-static-electricity/view/describers/WallDescriber.js index f39ea56a..df7dda89 100644 --- a/js/balloons-and-static-electricity/view/describers/WallDescriber.js +++ b/js/balloons-and-static-electricity/view/describers/WallDescriber.js @@ -93,7 +93,7 @@ define( function( require ) { * @public * @param {BalloonModel} yellowBalloon * @param {BalloonModel} greenBalloon - * @return {string} + * @returns {string} */ getWallDescription: function( yellowBalloon, greenBalloon, balloonsAdjacent ) { var description; @@ -122,7 +122,7 @@ define( function( require ) { * Get the described charge in the wall, dependent on charge visibility, whether or not there is induced charge, * and which balloons are visible. This portion of the description does not include any wall position information. * - * @return {string} + * @returns {string} */ getWallChargeDescription: function( yellowBalloon, greenBalloon, balloonsAdjacent, wallVisible, chargesShown ) { var descriptionString; @@ -217,7 +217,7 @@ define( function( require ) { * @param {boolean} wallVisible * @param {string} chargesShown * - * @return {string} + * @returns {string} */ getWallChargeDescriptionWithLabel: function( yellowBalloon, greenBalloon, balloonsAdjacent, wallVisible, chargesShown ) { var description = WallDescriber.getWallChargeDescription( yellowBalloon, greenBalloon, balloonsAdjacent, wallVisible, chargesShown ); @@ -232,7 +232,7 @@ define( function( require ) { * Get the induced charge amount description for the balloon, describing whether the charges are * "a little bit" displaced and so on. * @param {BalloonModel} balloon - * @return {string} + * @returns {string} */ getInducedChargeAmountDescription: function( balloon ) { @@ -252,7 +252,7 @@ define( function( require ) { * "In wall, no change in charges." * * @param {string} locationString - * @return {string} + * @returns {string} */ getNoChangeInChargesDescription: function( locationString ) { return StringUtils.fillIn( wallNoChangeInChargesPatternString, { @@ -267,7 +267,7 @@ define( function( require ) { * @param {BalloonModel} balloon * @param {string} balloonLabel * @param {boolean} wallVisible - * @return {string} + * @returns {string} */ getInducedChargeDescriptionWithNoAmount: function( balloon, balloonLabel, wallVisible ) { var descriptionString; @@ -348,7 +348,7 @@ define( function( require ) { * "Negative charges in wall move away from balloons quite a lot. Positive charges do not move." or * "Negative charges in lower wall move away from balloons quite a lot. Positive charges do not move." * - * @return {string} + * @returns {string} */ getCombinedInducedChargeDescription: function( balloon, wallVisible, options ) { @@ -394,7 +394,7 @@ define( function( require ) { * @param wallVisible * @param {[type]} includeWallLocation [description] * - * @return {[type]} [description] + * @returns {[type]} [description] */ getInducedChargeLocationDescription: function( balloon, wallVisible, includeWallLocation ) { var chargeLocationX = PlayAreaMap.X_LOCATIONS.AT_WALL; @@ -409,7 +409,7 @@ define( function( require ) { * * @param {string} chargesShown - one of 'none'|'all'|'diff' * @param numberOfCharges - * @return {string} + * @returns {string} */ getSummaryChargeDescription: function( chargesShown, numberOfCharges ) { var chargeString = BASEDescriber.getNeutralChargesShownDescription( chargesShown, numberOfCharges );