1
0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00

JSdoc documentation fixed

This commit is contained in:
NetHans 2022-08-18 21:27:59 +02:00
parent b7a016edcf
commit e147602a3a

View File

@ -133,9 +133,9 @@ class Flow {
* Checks if node A and node B are in the same group. * Checks if node A and node B are in the same group.
* Node B can also be placed in a subgroup. * Node B can also be placed in a subgroup.
* If node A is not in any group, false is returned * If node A is not in any group, false is returned
* @param {[type]} nodeIdA [description] * @param {Node} nodeIdA Node which defines the first search level
* @param {[type]} nodeIdB [description] * @param {Node} nodeIdB Node which is to be searched in the group or a subgroup
* @returns {[type]} Returns true if all nodes are in the same group. If not, then false or if node A is not in a group then also false. * @returns {boolean} Returns true if all nodes are in the same group. If not, then false or if node A is not in a group then also false.
*/ */
isNodeInSameGroup(nodeIdA, nodeIdB) { isNodeInSameGroup(nodeIdA, nodeIdB) {
const groups = this.global.groups; const groups = this.global.groups;
@ -154,9 +154,9 @@ class Flow {
/** /**
* Subfunction to recursively search the groups for matches * Subfunction to recursively search the groups for matches
* @param {[type]} targetNode [description] * @param {Node} Node which is to be searched in the group or a subgroup
* @param {[type]} targetGroup [description] * @param {Group} targetGroup group currently under analysis
* @returns Returns true if a match was found. Otherwise false. * @returns {boolean} Returns true if a match was found. Otherwise false.
*/ */
const isInSubGroup = (targetNode, targetGroup) => { const isInSubGroup = (targetNode, targetGroup) => {
let _result = false; let _result = false;