chore(documentation): fix JSDoc number types

This commit is contained in:
Philipp Fromme 2020-04-06 10:25:03 +02:00 committed by fake-join[bot]
parent 7a67ff95b2
commit fcb11a60f7
7 changed files with 15 additions and 15 deletions

View File

@ -12,8 +12,8 @@ import BaseViewer from './BaseViewer';
* *
* @param {Object} [options] configuration options to pass to the viewer * @param {Object} [options] configuration options to pass to the viewer
* @param {DOMElement} [options.container] the container to render the viewer in, defaults to body. * @param {DOMElement} [options.container] the container to render the viewer in, defaults to body.
* @param {string|Number} [options.width] the width of the viewer * @param {string|number} [options.width] the width of the viewer
* @param {string|Number} [options.height] the height of the viewer * @param {string|number} [options.height] the height of the viewer
* @param {Object} [options.moddleExtensions] extension packages to provide * @param {Object} [options.moddleExtensions] extension packages to provide
* @param {Array<didi.Module>} [options.modules] a list of modules to override the default modules * @param {Array<didi.Module>} [options.modules] a list of modules to override the default modules
* @param {Array<didi.Module>} [options.additionalModules] a list of modules to use with the default modules * @param {Array<didi.Module>} [options.additionalModules] a list of modules to use with the default modules

View File

@ -40,8 +40,8 @@ import {
* *
* @param {Object} [options] configuration options to pass to the viewer * @param {Object} [options] configuration options to pass to the viewer
* @param {DOMElement} [options.container] the container to render the viewer in, defaults to body. * @param {DOMElement} [options.container] the container to render the viewer in, defaults to body.
* @param {string|Number} [options.width] the width of the viewer * @param {string|number} [options.width] the width of the viewer
* @param {string|Number} [options.height] the height of the viewer * @param {string|number} [options.height] the height of the viewer
* @param {Object} [options.moddleExtensions] extension packages to provide * @param {Object} [options.moddleExtensions] extension packages to provide
* @param {Array<didi.Module>} [options.modules] a list of modules to override the default modules * @param {Array<didi.Module>} [options.modules] a list of modules to override the default modules
* @param {Array<didi.Module>} [options.additionalModules] a list of modules to use with the default modules * @param {Array<didi.Module>} [options.additionalModules] a list of modules to use with the default modules
@ -433,7 +433,7 @@ BaseViewer.prototype.destroy = function() {
* Remove a previously added listener via {@link #off(event, callback)}. * Remove a previously added listener via {@link #off(event, callback)}.
* *
* @param {string} event * @param {string} event
* @param {Number} [priority] * @param {number} [priority]
* @param {Function} callback * @param {Function} callback
* @param {Object} [that] * @param {Object} [that]
*/ */

View File

@ -123,8 +123,8 @@ var initialDiagram =
* *
* @param {Object} [options] configuration options to pass to the viewer * @param {Object} [options] configuration options to pass to the viewer
* @param {DOMElement} [options.container] the container to render the viewer in, defaults to body. * @param {DOMElement} [options.container] the container to render the viewer in, defaults to body.
* @param {string|Number} [options.width] the width of the viewer * @param {string|number} [options.width] the width of the viewer
* @param {string|Number} [options.height] the height of the viewer * @param {string|number} [options.height] the height of the viewer
* @param {Object} [options.moddleExtensions] extension packages to provide * @param {Object} [options.moddleExtensions] extension packages to provide
* @param {Array<didi.Module>} [options.modules] a list of modules to override the default modules * @param {Array<didi.Module>} [options.modules] a list of modules to override the default modules
* @param {Array<didi.Module>} [options.additionalModules] a list of modules to use with the default modules * @param {Array<didi.Module>} [options.additionalModules] a list of modules to use with the default modules

View File

@ -49,8 +49,8 @@ import BaseViewer from './BaseViewer';
* *
* @param {Object} [options] configuration options to pass to the viewer * @param {Object} [options] configuration options to pass to the viewer
* @param {DOMElement} [options.container] the container to render the viewer in, defaults to body. * @param {DOMElement} [options.container] the container to render the viewer in, defaults to body.
* @param {string|Number} [options.width] the width of the viewer * @param {string|number} [options.width] the width of the viewer
* @param {string|Number} [options.height] the height of the viewer * @param {string|number} [options.height] the height of the viewer
* @param {Object} [options.moddleExtensions] extension packages to provide * @param {Object} [options.moddleExtensions] extension packages to provide
* @param {Array<didi.Module>} [options.modules] a list of modules to override the default modules * @param {Array<didi.Module>} [options.modules] a list of modules to override the default modules
* @param {Array<didi.Module>} [options.additionalModules] a list of modules to use with the default modules * @param {Array<didi.Module>} [options.additionalModules] a list of modules to use with the default modules

View File

@ -101,7 +101,7 @@ export function getFlowNodePosition(source, element) {
* @param {djs.model.Shape} source * @param {djs.model.Shape} source
* @param {djs.model.Shape} element * @param {djs.model.Shape} element
* *
* @return {Number} distance * @return {number} distance
*/ */
export function getFlowNodeDistance(source, element) { export function getFlowNodeDistance(source, element) {

View File

@ -6,9 +6,9 @@ var sqrt = Math.sqrt,
/** /**
* Calculate the square (power to two) of a number. * Calculate the square (power to two) of a number.
* *
* @param {Number} n * @param {number} n
* *
* @return {Number} * @return {number}
*/ */
function sq(n) { function sq(n) {
return Math.pow(n, 2); return Math.pow(n, 2);
@ -20,7 +20,7 @@ function sq(n) {
* @param {Point} p1 * @param {Point} p1
* @param {Point} p2 * @param {Point} p2
* *
* @return {Number} * @return {number}
*/ */
function getDistance(p1, p2) { function getDistance(p1, p2) {
return sqrt(sq(p1.x - p2.x) + sq(p1.y - p2.y)); return sqrt(sq(p1.x - p2.x) + sq(p1.y - p2.y));
@ -127,7 +127,7 @@ export function getAttachment(point, line) {
* @param {Point} s1 segment start * @param {Point} s1 segment start
* @param {Point} s2 segment end * @param {Point} s2 segment end
* @param {Point} cc circle center * @param {Point} cc circle center
* @param {Number} cr circle radius * @param {number} cr circle radius
* *
* @return {Array<Point>} intersections * @return {Array<Point>} intersections
*/ */

View File

@ -6,7 +6,7 @@ import {
/** /**
* Create a fake key event for testing purposes. * Create a fake key event for testing purposes.
* *
* @param {string|Number} key the key or keyCode/charCode * @param {string|number} key the key or keyCode/charCode
* @param {Object} [attrs] * @param {Object} [attrs]
* *
* @return {Event} * @return {Event}