From c1c9121fcc22fa32f0f298fd31779c1a06c5aec3 Mon Sep 17 00:00:00 2001 From: Sam El-Husseini Date: Wed, 16 Oct 2019 17:01:36 -0500 Subject: [PATCH] Fix jsdoc. @return instead of @returns (#3271) * Fix jsdoc. @return instead of @returns --- core/field_textinput.js | 4 ++-- core/renderers/measurables/rows.js | 4 ++-- core/renderers/zelos/measurables/rows.js | 4 ++-- demos/custom-fields/pitch/field_pitch.js | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/core/field_textinput.js b/core/field_textinput.js index 2d7d3b762..2fb87c2e2 100644 --- a/core/field_textinput.js +++ b/core/field_textinput.js @@ -528,7 +528,7 @@ Blockly.FieldTextInput.prototype.getText_ = function() { * than the field's value. This should be coupled with an override of * `getValueFromEditorText_`. * @param {*} value The value stored in this field. - * @returns {string} The text to show on the html input. + * @return {string} The text to show on the html input. * @protected */ Blockly.FieldTextInput.prototype.getEditorText_ = function(value) { @@ -542,7 +542,7 @@ Blockly.FieldTextInput.prototype.getEditorText_ = function(value) { * than the field's value. This should be coupled with an override of * `getEditorText_`. * @param {string} text Text received from the html input. - * @returns {*} The value to store. + * @return {*} The value to store. * @protected */ Blockly.FieldTextInput.prototype.getValueFromEditorText_ = function(text) { diff --git a/core/renderers/measurables/rows.js b/core/renderers/measurables/rows.js index 7b85ae0f0..b998eb7f3 100644 --- a/core/renderers/measurables/rows.js +++ b/core/renderers/measurables/rows.js @@ -280,7 +280,7 @@ Blockly.utils.object.inherits(Blockly.blockRendering.TopRow, /** * Returns whether or not the top row has a left square corner. * @param {!Blockly.BlockSvg} block The block whose top row this represents. - * @returns {boolean} Whether or not the top row has a left square corner. + * @return {boolean} Whether or not the top row has a left square corner. */ Blockly.blockRendering.TopRow.prototype.hasLeftSquareCorner = function(block) { var hasHat = block.hat ? block.hat === 'cap' : Blockly.BlockSvg.START_HAT; @@ -372,7 +372,7 @@ Blockly.utils.object.inherits(Blockly.blockRendering.BottomRow, /** * Returns whether or not the bottom row has a left square corner. * @param {!Blockly.BlockSvg} block The block whose bottom row this represents. - * @returns {boolean} Whether or not the bottom row has a left square corner. + * @return {boolean} Whether or not the bottom row has a left square corner. */ Blockly.blockRendering.BottomRow.prototype.hasLeftSquareCorner = function( block) { diff --git a/core/renderers/zelos/measurables/rows.js b/core/renderers/zelos/measurables/rows.js index 376fa90e3..8fa9e495d 100644 --- a/core/renderers/zelos/measurables/rows.js +++ b/core/renderers/zelos/measurables/rows.js @@ -70,7 +70,7 @@ Blockly.zelos.TopRow.prototype.hasLeftSquareCorner = function(block) { /** * Returns whether or not the top row has a right square corner. * @param {!Blockly.BlockSvg} block The block whose top row this represents. - * @returns {boolean} Whether or not the top row has a left square corner. + * @return {boolean} Whether or not the top row has a left square corner. */ Blockly.zelos.TopRow.prototype.hasRightSquareCorner = function(block) { // Render a round corner unless the block has an output connection. @@ -112,7 +112,7 @@ Blockly.zelos.BottomRow.prototype.hasLeftSquareCorner = function(block) { /** * Returns whether or not the bottom row has a right square corner. * @param {!Blockly.BlockSvg} block The block whose bottom row this represents. - * @returns {boolean} Whether or not the bottom row has a left square corner. + * @return {boolean} Whether or not the bottom row has a left square corner. */ Blockly.zelos.BottomRow.prototype.hasRightSquareCorner = function(block) { // Render a round corner unless the block has an output connection. diff --git a/demos/custom-fields/pitch/field_pitch.js b/demos/custom-fields/pitch/field_pitch.js index b69789d52..f5bdf505b 100644 --- a/demos/custom-fields/pitch/field_pitch.js +++ b/demos/custom-fields/pitch/field_pitch.js @@ -173,7 +173,7 @@ CustomFields.FieldPitch.prototype.getText_ = function() { /** * Transform the provided value into a text to show in the HTML input. * @param {*} value The value stored in this field. - * @returns {string} The text to show on the HTML input. + * @return {string} The text to show on the HTML input. */ CustomFields.FieldPitch.prototype.getEditorText_ = function(value) { return this.valueToNote(value); @@ -183,7 +183,7 @@ CustomFields.FieldPitch.prototype.getEditorText_ = function(value) { * Transform the text received from the HTML input (note) into a value * to store in this field. * @param {string} text Text received from the HTML input. - * @returns {*} The value to store. + * @return {*} The value to store. */ CustomFields.FieldPitch.prototype.getValueFromEditorText_ = function(text) { return this.noteToValue(text);