sartography
/
bpmn-js
mirror of https://github.com/sartography/bpmn-js.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore(documentation): fix JSDoc boolean types

This commit is contained in:
Philipp Fromme 2020-04-06 10:26:04 +02:00 committed by fake-join[bot]
parent fcb11a60f7
commit 2dd1e13305
8 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/BaseViewer.js
View File

@ -238,8 +238,8 @@ BaseViewer.prototype.open = function(bpmnDiagramOrId, done) {
* You can use these events to hook into the life-cycle. * You can use these events to hook into the life-cycle.
* *
* @param {Object} [options] export options * @param {Object} [options] export options
* @param {Boolean} [options.format=false] output formatted XML * @param {boolean} [options.format=false] output formatted XML
* @param {Boolean} [options.preamble=true] output preamble * @param {boolean} [options.preamble=true] output preamble
* *
* @param {Function} done invoked with (err, xml) * @param {Function} done invoked with (err, xml)
*/ */

2
lib/features/modeling/behavior/GroupBehavior.js
View File

@ -100,7 +100,7 @@ export default function GroupBehavior(
* *
* @param {Array<djs.model.shape>} elements * @param {Array<djs.model.shape>} elements
* @param {ModdleElement} categoryValue * @param {ModdleElement} categoryValue
* @return {Boolean} * @return {boolean}
*/ */
function isReferenced(elements, categoryValue) { function isReferenced(elements, categoryValue) {
return elements.some(function(e) { return elements.some(function(e) {

2
lib/features/modeling/util/ModelingUtil.js
View File

@ -11,7 +11,7 @@ import { is } from '../../../util/ModelUtil';
* @param {djs.model.Base} element * @param {djs.model.Base} element
* @param {Array<string>} types * @param {Array<string>} types
* *
* @return {Boolean} * @return {boolean}
*/ */
export function isAny(element, types) { export function isAny(element, types) {
return some(types, function(t) { return some(types, function(t) {

2
lib/features/popup-menu/util/TypeUtil.js
View File

@ -14,7 +14,7 @@ import {
* *
* @param {djs.model.Base} element * @param {djs.model.Base} element
* *
* @return {Boolean} * @return {boolean}
*/ */
export function isDifferentType(element) { export function isDifferentType(element) {

4
lib/features/rules/BpmnRules.js
View File

@ -201,7 +201,7 @@ BpmnRules.prototype.canCopy = canCopy;
* Checks if given element can be used for starting connection. * Checks if given element can be used for starting connection.
* *
* @param {Element} source * @param {Element} source
* @return {Boolean} * @return {boolean}
*/ */
function canStartConnection(element) { function canStartConnection(element) {
if (nonExistingOrLabel(element)) { if (nonExistingOrLabel(element)) {
@ -435,7 +435,7 @@ function canConnect(source, target, connection) {
/** /**
* Can an element be dropped into the target element * Can an element be dropped into the target element
* *
* @return {Boolean} * @return {boolean}
*/ */
function canDrop(element, target, position) { function canDrop(element, target, position) {

2
lib/import/BpmnTreeWalker.js
View File

@ -21,7 +21,7 @@ var diRefs = new Refs(
* @param {ModdleElement} element * @param {ModdleElement} element
* @param {string} type * @param {string} type
* *
* @return {Boolean} * @return {boolean}
*/ */
function is(element, type) { function is(element, type) {
return element.$instanceOf(type); return element.$instanceOf(type);

4
lib/util/LabelUtil.js
View File

@ -17,7 +17,7 @@ export var FLOW_LABEL_INDENT = 15;
* Returns true if the given semantic has an external label * Returns true if the given semantic has an external label
* *
* @param {BpmnElement} semantic * @param {BpmnElement} semantic
* @return {Boolean} true if has label * @return {boolean} true if has label
*/ */
export function isLabelExternal(semantic) { export function isLabelExternal(semantic) {
return is(semantic, 'bpmn:Event') || return is(semantic, 'bpmn:Event') ||
@ -35,7 +35,7 @@ export function isLabelExternal(semantic) {
* Returns true if the given element has an external label * Returns true if the given element has an external label
* *
* @param {djs.model.shape} element * @param {djs.model.shape} element
* @return {Boolean} true if has label * @return {boolean} true if has label
*/ */
export function hasExternalLabel(element) { export function hasExternalLabel(element) {
return isLabel(element.label); return isLabel(element.label);

2
lib/util/ModelUtil.js
View File

@ -4,7 +4,7 @@
* @param {djs.model.Base|ModdleElement} element * @param {djs.model.Base|ModdleElement} element
* @param {string} type * @param {string} type
* *
* @return {Boolean} * @return {boolean}
*/ */
export function is(element, type) { export function is(element, type) {
var bo = getBusinessObject(element); var bo = getBusinessObject(element);