CodingPirates/blockly
1
0
Fork 0
mirror of https://github.com/google/blockly.git synced 2026-01-04 15:40:08 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4995 from BeksOmega/fix/jsdoc

Browse Source 
Updates JSDoc in Block and BlockSvg
This commit is contained in:
Rachel Fenichel
2021-07-09 15:57:38 -07:00
committed by GitHub
parent 61e2d4caee a589cd6923
commit 89cf049e74
2 changed files with 21 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
core/block.js
View File

@@ -739,6 +739,7 @@ Blockly.Block.prototype.getChildren = function(ordered) {
/**
* Set parent of this block to be a new block or null.
* @param {Blockly.Block} newParent New parent block.
* @package
*/
Blockly.Block.prototype.setParent = function(newParent) {
if (newParent == this.parentBlock_) {
@@ -850,6 +851,7 @@ Blockly.Block.prototype.isShadow = function() {
/**
* Set whether this block is a shadow block or not.
* @param {boolean} shadow True if a shadow.
* @package
*/
Blockly.Block.prototype.setShadow = function(shadow) {
this.isShadow_ = shadow;

28
core/block_svg.js
View File

@@ -296,7 +296,8 @@ Blockly.BlockSvg.prototype.getColourBorder = function() {
};
/**
* Select this block. Highlight it visually.
* Selects this block. Highlights the block visually and fires a select event
* if the block is not already selected.
*/
Blockly.BlockSvg.prototype.select = function() {
if (this.isShadow() && this.getParent()) {
@@ -326,7 +327,8 @@ Blockly.BlockSvg.prototype.select = function() {
};
/**
* Unselect this block. Remove its highlighting.
* Unselects this block. Unhighlights the block and fires a select (false) event
* if the block is currently selected.
*/
Blockly.BlockSvg.prototype.unselect = function() {
if (Blockly.selected != this) {
@@ -385,8 +387,9 @@ Blockly.BlockSvg.prototype.getIcons = function() {
};
/**
* Set parent of this block to be a new block or null.
* Sets the parent of this block to be a new block or null.
* @param {?Blockly.Block} newParent New parent block.
* @package
* @override
*/
Blockly.BlockSvg.prototype.setParent = function(newParent) {
@@ -749,8 +752,8 @@ Blockly.BlockSvg.prototype.showHelp = function() {
/**
* Generate the context menu for this block.
* @protected
* @return {?Array<!Object>} Context menu options or null if no menu.
* @protected
*/
Blockly.BlockSvg.prototype.generateContextMenu = function() {
if (this.workspace.options.readOnly || !this.contextMenu) {
@@ -858,8 +861,9 @@ Blockly.BlockSvg.prototype.setEditable = function(editable) {
};
/**
* Set whether this block is a shadow block or not.
* Sets whether this block is a shadow block or not.
* @param {boolean} shadow True if a shadow.
* @package
*/
Blockly.BlockSvg.prototype.setShadow = function(shadow) {
Blockly.BlockSvg.superClass_.setShadow.call(this, shadow);
@@ -974,7 +978,7 @@ Blockly.BlockSvg.prototype.toCopyData = function() {
};
/**
* Change the colour of a block.
* Updates the colour of the block to match the block's state.
* @package
*/
Blockly.BlockSvg.prototype.applyColour = function() {
@@ -993,7 +997,9 @@ Blockly.BlockSvg.prototype.applyColour = function() {
};
/**
* Enable or disable a block.
* Updates the color of the block (and children) to match the current disabled
* state.
* @package
*/
Blockly.BlockSvg.prototype.updateDisabled = function() {
var children = this.getChildren(false);
@@ -1184,14 +1190,18 @@ Blockly.BlockSvg.prototype.setHighlighted = function(highlighted) {
};
/**
* Select this block. Highlight it visually.
* Adds the visual "select" effect to the block, but does not actually select
* it or fire an event.
* @see Blockly.BlockSvg#select
*/
Blockly.BlockSvg.prototype.addSelect = function() {
this.pathObject.updateSelected(true);
};
/**
* Unselect this block. Remove its highlighting.
* Removes the visual "select" effect from the block, but does not actually
* unselect it or fire an event.
* @see Blockly.BlockSvg#unselect
*/
Blockly.BlockSvg.prototype.removeSelect = function() {
this.pathObject.updateSelected(false);