- Docs (JSDoc): Further on preferring void

This commit is contained in:
Brett Zamir
2019-04-16 08:59:16 +08:00
parent 894fed3e80
commit d84f39cb3f
62 changed files with 576 additions and 575 deletions

View File

@@ -76,7 +76,7 @@ class Layer {
/**
* Active this layer so it takes pointer events.
* @returns {undefined}
* @returns {void}
*/
activate () {
this.group_.setAttribute('style', 'pointer-events:all');
@@ -84,7 +84,7 @@ class Layer {
/**
* Deactive this layer so it does NOT take pointer events.
* @returns {undefined}
* @returns {void}
*/
deactivate () {
this.group_.setAttribute('style', 'pointer-events:none');
@@ -93,7 +93,7 @@ class Layer {
/**
* Set this layer visible or hidden based on 'visible' parameter.
* @param {boolean} visible - If true, make visible; otherwise, hide it.
* @returns {undefined}
* @returns {void}
*/
setVisible (visible) {
const expected = visible === undefined || visible ? 'inline' : 'none';
@@ -127,7 +127,7 @@ class Layer {
* Sets the opacity of this layer. If opacity is not a value between 0.0 and 1.0,
* nothing happens.
* @param {Float} opacity - A float value in the range 0.0-1.0
* @returns {undefined}
* @returns {void}
*/
setOpacity (opacity) {
if (typeof opacity === 'number' && opacity >= 0.0 && opacity <= 1.0) {
@@ -138,7 +138,7 @@ class Layer {
/**
* Append children to this layer.
* @param {SVGGElement} children - The children to append to this layer.
* @returns {undefined}
* @returns {void}
*/
appendChildren (children) {
for (let i = 0; i < children.length; ++i) {
@@ -208,7 +208,7 @@ Layer.CLASS_REGEX = new RegExp('(\\s|^)' + Layer.CLASS_NAME + '(\\s|$)');
* Add class `Layer.CLASS_NAME` to the element (usually `class='layer'`).
*
* @param {SVGGElement} elem - The SVG element to update
* @returns {undefined}
* @returns {void}
*/
function addLayerClass (elem) {
const classes = elem.getAttribute('class');