More JSDoc improvements

This commit is contained in:
Neil Fraser
2021-05-27 13:09:50 -07:00
committed by Neil Fraser
parent f64c11d74e
commit e661c92a36
32 changed files with 154 additions and 158 deletions

View File

@@ -748,7 +748,7 @@ Blockly.BlockSvg.prototype.showHelp = function() {
/**
* Generate the context menu for this block.
* @protected
* @return {Array<!Object>} Context menu options
* @return {?Array<!Object>} Context menu options or null if no menu.
*/
Blockly.BlockSvg.prototype.generateContextMenu = function() {
if (this.workspace.options.readOnly || !this.contextMenu) {
@@ -1009,7 +1009,7 @@ Blockly.BlockSvg.prototype.updateDisabled = function() {
/**
* Get the comment icon attached to this block, or null if the block has no
* comment.
* @return {Blockly.Comment} The comment icon attached to this block, or null.
* @return {?Blockly.Comment} The comment icon attached to this block, or null.
*/
Blockly.BlockSvg.prototype.getCommentIcon = function() {
return this.commentIcon_;
@@ -1138,7 +1138,7 @@ Blockly.BlockSvg.prototype.setWarningText = function(text, opt_id) {
/**
* Give this block a mutator dialog.
* @param {Blockly.Mutator} mutator A mutator dialog instance or null to remove.
* @param {?Blockly.Mutator} mutator A mutator dialog instance or null to remove.
*/
Blockly.BlockSvg.prototype.setMutator = function(mutator) {
if (this.mutator && this.mutator !== mutator) {
@@ -1234,7 +1234,7 @@ Blockly.BlockSvg.prototype.setColour = function(colour) {
/**
* Set the style and colour values of a block.
* @param {string} blockStyleName Name of the block style
* @param {string} blockStyleName Name of the block style.
* @throws {Error} if the block style does not exist.
*/
Blockly.BlockSvg.prototype.setStyle = function(blockStyleName) {
@@ -1473,7 +1473,7 @@ Blockly.BlockSvg.prototype.getConnections_ = function(all) {
/**
* Walks down a stack of blocks and finds the last next connection on the stack.
* @return {Blockly.RenderedConnection} The last next connection on the stack,
* @return {?Blockly.RenderedConnection} The last next connection on the stack,
* or null.
* @package
* @override
@@ -1489,7 +1489,7 @@ Blockly.BlockSvg.prototype.lastConnectionInStack = function() {
* Used to match connections between a block and its insertion marker.
* @param {!Blockly.Block} otherBlock The other block to match against.
* @param {!Blockly.Connection} conn The other connection to match.
* @return {Blockly.RenderedConnection} The matching connection on this block,
* @return {?Blockly.RenderedConnection} The matching connection on this block,
* or null.
* @package
* @override
@@ -1603,7 +1603,7 @@ Blockly.BlockSvg.prototype.positionNearConnection = function(sourceConnection,
/**
* Return the parent block or null if this block is at the top level.
* @return {Blockly.BlockSvg} The block that holds the current block.
* @return {?Blockly.BlockSvg} The block (if any) that holds the current block.
* @override
*/
Blockly.BlockSvg.prototype.getParent = function() {