Fix jsdoc. @return instead of @returns (#3271)

* Fix jsdoc. @return instead of @returns
This commit is contained in:
Sam El-Husseini
2019-10-16 17:01:36 -05:00
committed by GitHub
parent 8407428e8f
commit c1c9121fcc
4 changed files with 8 additions and 8 deletions

View File

@@ -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) {

View File

@@ -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) {

View File

@@ -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.

View File

@@ -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);