Fix jsdoc syntax (#3242)

This commit is contained in:
alschmiedt
2019-10-14 14:22:09 -07:00
committed by GitHub
parent d35bc19bff
commit 8874e58f91
3 changed files with 54 additions and 20 deletions

View File

@@ -40,7 +40,8 @@ Blockly.Component = function() {
/**
* Whether the component is rendered right-to-left.
* @private {boolean}
* @type {boolean}
* @private
*/
this.rightToLeft_ = Blockly.Component.defaultRightToLeft;
@@ -48,26 +49,30 @@ Blockly.Component = function() {
* Unique ID of the component, lazily initialized in {@link
* Blockly.Component#getId} if needed. This property is strictly private and
* must not be accessed directly outside of this class!
* @private {?string}
* @type {?string}
* @private
*/
this.id_ = null;
/**
* Whether the component is in the document.
* @private {boolean}
* @type {boolean}
* @private
*/
this.inDocument_ = false;
/**
* The DOM element for the component.
* @private {?Element}
* @type {?Element}
* @private
*/
this.element_ = null;
/**
* Parent component to which events will be propagated. This property is
* strictly private and must not be accessed directly outside of this class!
* @private {?Blockly.Component}
* @type {?Blockly.Component}
* @private
*/
this.parent_ = null;
@@ -75,7 +80,8 @@ Blockly.Component = function() {
* Array of child components.
* Must be kept in sync with `childIndex_`. This property is strictly
* private and must not be accessed directly outside of this class!
* @private {?Array.<?Blockly.Component>}
* @type {?Array.<?Blockly.Component>}
* @private
*/
this.children_ = [];
@@ -85,7 +91,8 @@ Blockly.Component = function() {
* Must be kept in sync with `children_`. This property is strictly
* private and must not be accessed directly outside of this class!
*
* @private {?Object}
* @type {?Object}
* @private
*/
this.childIndex_ = {};
};

View File

@@ -58,55 +58,81 @@ Blockly.tree.BaseNode = function(content, config) {
*/
this.content_ = content;
/** @private {string} */
/**
* @type {string}
* @private
*/
this.iconClass_;
/** @private {string} */
/**
* @type {string}
* @private
*/
this.expandedIconClass_;
/** @protected {Blockly.tree.TreeControl} */
/**
* @type {Blockly.tree.TreeControl}
* @protected
*/
this.tree;
/** @private {Blockly.tree.BaseNode} */
/**
* @type {Blockly.tree.BaseNode}
* @private
*/
this.previousSibling_;
/** @private {Blockly.tree.BaseNode} */
/**
* @type {Blockly.tree.BaseNode}
* @private
*/
this.nextSibling_;
/** @private {Blockly.tree.BaseNode} */
/**
* @type {Blockly.tree.BaseNode}
* @private
*/
this.firstChild_;
/** @private {Blockly.tree.BaseNode} */
/**
* @type {Blockly.tree.BaseNode}
* @private
*/
this.lastChild_;
/**
* Whether the tree item is selected.
* @private {boolean}
* @type {boolean}
* @private
*/
this.selected_ = false;
/**
* Whether the tree node is expanded.
* @private {boolean}
* @type {boolean}
* @private
*/
this.expanded_ = false;
/**
* Tooltip for the tree item
* @private {?string}
* @type {?string}
* @private
*/
this.toolTip_ = null;
/**
* Whether to allow user to collapse this node.
* @private {boolean}
* @type {boolean}
* @private
*/
this.isUserCollapsible_ = true;
/**
* Nesting depth of this node; cached result of computeDepth_.
* -1 if value has not been cached.
* @private {number}
* @type {number}
* @private
*/
this.depth_ = -1;
};

View File

@@ -52,7 +52,8 @@ Blockly.tree.TreeControl = function(toolbox, config) {
/**
* Currently selected item.
* @private {Blockly.tree.BaseNode}
* @type {Blockly.tree.BaseNode}
* @private
*/
this.selectedItem_ = this;
};