diff --git a/collapse/collapse.spec b/collapse/collapse.spec index 57a58264..53a8fdcc 100755 --- a/collapse/collapse.spec +++ b/collapse/collapse.spec @@ -41,7 +41,7 @@ "getCard" : { "returns" : "card", "parameters": [ - { "name": "index", "type": "int" }, + { "name": "cardIndex", "type": "int" }, { "name": "collapsibleIndex", "type": "int", "optional": true } ] }, @@ -66,7 +66,7 @@ "getCollapsibleById": { "returns" : "collapsible", "parameters": [ - { "name": "collapsibleId", "type": "string" } + { "name": "collapsibleId", "type": "string", "optional": true } ] }, "removeCollapsibleById": { @@ -78,7 +78,7 @@ "removeCollapsibleAt" : { "returns" : "boolean", "parameters": [ - { "name": "index", "type": "int" } + { "name": "index", "type": "int", "optional": true } ] }, "removeAllCollapsibles": { @@ -87,7 +87,8 @@ "isCollapsed" : { "parameters": [ { "name": "index", "type": "int", "optional": true } - ] + ], + "returns": "boolean" }, "setCollapsibles" : { "parameters": [ diff --git a/collapse/collapse_doc.js b/collapse/collapse_doc.js index c011618e..1aea639f 100644 --- a/collapse/collapse_doc.js +++ b/collapse/collapse_doc.js @@ -1,7 +1,7 @@ /** * Toggles the collapsible at the given index (or the first/only one, if no index is given) * - * @param {Number} index the index of the collapsible to toggle + * @param {Number} [index] the index of the collapsible to toggle */ function toggle(index) { } @@ -9,7 +9,7 @@ function toggle(index) { /** * Shows the collapsible at the given index (or the first/only one, if no index is given) * - * @param {Number} index the index of the collapsible to show + * @param {Number} [index] The index of the collapsible to show */ function show(index) {} @@ -17,7 +17,7 @@ function show(index) {} /** * Hides the collapsible at the given index (or the first/only one, if no index is given) * - * @param {Number} index the index of the collapsible to hide + * @param {Number} [index] tTe index of the collapsible to hide */ function hide(index) { } @@ -26,10 +26,10 @@ function hide(index) { /** * Creates a new collapsible that can be added to the Collapse component using addCollapsible / setCollapsibles * - * @param {String} [headerHtml] - * @param {String} [collapsibleId] + * @param {String} [headerHtml] The HTML content to be used as the header of the collapsible. + * @param {String} [collapsibleId] The unique identifier for the collapsible. * - * @return {CustomType} + * @return {CustomType} Returns a newly created collapsible object with the specified header and ID. */ function createCollapsible(headerHtml, collapsibleId) { } @@ -37,10 +37,10 @@ function createCollapsible(headerHtml, collapsibleId) { /** * Creates a new card that can be added to any collapsible's cards array * - * @param {String} [textOrHtml] - * @param {String} [cardId] - * @param {String} [styleClass] - * @return {CustomType} + * @param {String} [textOrHtml] The text or HTML content to be displayed inside the card. + * @param {String} [cardId] The unique identifier for the card. If not provided, an ID may be generated automatically. + * @param {String} [styleClass] A custom style class to apply to the card for styling purposes. + * @return {CustomType} Returns a newly created card object with the specified content, ID, and style class. */ function createCard(textOrHtml, cardId, styleClass) { } @@ -48,8 +48,8 @@ function createCard(textOrHtml, cardId, styleClass) { /** * Adds a new collapsible to the list of collapsibles of this Collapse component * - * @param {CustomType} collapsible - * @param {Number} [index] the index to insert the new collapsible at + * @param {CustomType} collapsible The collapsible object to be added to the Collapse component. + * @param {Number} [index] The 0-based index at which to insert the new collapsible. If not provided, the collapsible is added at the end. */ function addCollapsible(collapsible, index) { } @@ -57,15 +57,15 @@ function addCollapsible(collapsible, index) { /** * Sets all collapsibles of this Collapse component * - * @param {Array>} collapsibles + * @param {Array>} collapsibles An array of collapsible objects to set as the complete list of collapsibles for the Collapse component. */ function setCollapsibles(collapsibles) { } /** * Returns the card with the given ID - * @param {String} cardId - * @return {CustomType} the card or null when not found + * @param {String} cardId The unique identifier of the card to retrieve. + * @return {CustomType} Returns the card object with the specified ID, or `null` if the card is not found. */ function getCardById(cardId) { } @@ -75,34 +75,34 @@ function getCardById(cardId) { * @param {Number} cardIndex the index of the card to get (0 based) * @param {Number} [collapsibleIndex] if not given, the first collapsible is used * - * @return {CustomType} the card or null when not found + * @return {CustomType} the card or null when not found */ function getCard(cardIndex, collapsibleIndex) { } /** * Returns the collapsible with the given index (0 based) - * @param {Number} [collapsibleIndex] if not given, the first collapsible is used + * @param {Number} index if not given, the first collapsible is used * - * @return {CustomType} the card or null when not found + * @return {CustomType} the collapsible or null when not found */ -function getCollapsible(collapsibleIndex) { +function getCollapsible(index) { } /** * Returns whether the collapsible at the given index (or the first one if no index is provided) is collapsed - * @param {Number} [collapsibleIndex] * - * @return {Boolean} + * @param {Number} [index] The 0-based index of the collapsible to check. If omitted, the method checks the first collapsible. + * @return {Boolean} Returns `true` if the specified collapsible (or the first one by default) is collapsed, otherwise `false`. */ -function isCollapsed(collapsibleIndex) { +function isCollapsed(index) { } /** * Returns the collapsible with the given ID * @param {String} [collapsibleId] if not given, the first collapsible is used * - * @return {CustomType} the card or null when not found + * @return {CustomType} the card or null when not found */ function getCollapsibleById(collapsibleId) { } @@ -117,12 +117,12 @@ function removeCollapsibleById(collapsibleId) { } /** - * Remove the collapsible with the given index (the index is 0 based) or the first collapsible if no collapsibleIndex is given. If the collapsible was showing a form, it will hide that form as well. - * @param {Number} [collapsibleIndex] the index of the collapsible to remove; if not given, the first collapsible is used + * Remove the collapsible with the given index (the index is 0 based) or the first collapsible if no index is given. If the collapsible was showing a form, it will hide that form as well. + * @param {Number} [index] the index of the collapsible to remove; if not given, the first collapsible is used * - * @return {Boolean} true if the collapsible at the give index (or 0 if not given) was removed; false if collapsibleIndex is out of bounds or if the form shown by this collapsible denied hide. + * @return {Boolean} true if the collapsible at the give index (or 0 if not given) was removed; false if index is out of bounds or if the form shown by this collapsible denied hide. */ -function removeCollapsibleAt(collapsibleIndex) { +function removeCollapsibleAt(index) { } /** @@ -130,7 +130,7 @@ function removeCollapsibleAt(collapsibleIndex) { * * If one of the collapsibles has a form showing that denies hide, the removeAllCollapsibles operation will stop and return false. In this case, all collapsibles that had forms and were hidden so far will still be in the collapsible array but they will be 'collapsed'. * - * @return {Boolean} true if all collapsibles were removed successfully; false if one of the collapsibles had a form which denied hide. + * @return {Boolean} `true` if all collapsibles were removed successfully; `false` if one of the collapsibles had a form which denied hide. */ function removeAllCollapsibles() { } diff --git a/sidenav/sidenav.spec b/sidenav/sidenav.spec index 72a204d4..e78dfc27 100644 --- a/sidenav/sidenav.spec +++ b/sidenav/sidenav.spec @@ -125,7 +125,8 @@ "parameters": [ { "name": "menuItemId", "type": "object" } - ] + ], + "deprecated": "use setSelectedMenuItem(id, false, false) instead" }, "addMenuItem" :{ "parameters":[ diff --git a/sidenav/sidenav_doc.js b/sidenav/sidenav_doc.js index bb30914c..9fc2bded 100644 --- a/sidenav/sidenav_doc.js +++ b/sidenav/sidenav_doc.js @@ -19,9 +19,8 @@ function setSelectedMenuItemAsync(id) { * Returns true if the menuItem is expanded. * @public * - * @param {String|Number} menuItemId - * - * @return {Boolean} + * @param {String|Number} menuItemId The unique identifier of the menu item to check. + * @return {Boolean} Returns `true` if the specified menu item is currently expanded, otherwise `false`. */ function isMenuItemExpanded(menuItemId) { } @@ -32,9 +31,8 @@ function isMenuItemExpanded(menuItemId) { * NOTE: The method returns false if any ancestor of the menuItem is not enabled; if the property enabled of the menuItem is set to true, but has a parent with the enabled property set to false, then isMenuItemEnabled returns false.
* @public * - * @param {String|Number} menuItemId - * - * @return {Boolean} + * @param {String|Number} menuItemId The unique identifier of the menu item to check. + * @return {Boolean} Returns `true` if the specified menu item and all its ancestors are enabled. Returns `false` if the `menuItemId` cannot be found or if any ancestor of the menu item is not enabled. */ function isMenuItemEnabled(menuItemId) { } @@ -43,7 +41,7 @@ function isMenuItemEnabled(menuItemId) { * Retrieves the screen location of a specific menu item. Returns the location as point (object with x and y properties). * * @param {Object} menuItemId The node to retrieve location for. - * @return {point} the location of the menu item. + * @return {Point} the location of the menu item. */ function getLocation(nodeId) { } @@ -51,17 +49,18 @@ function getLocation(nodeId) { /** * Retrieves the size of a specific menu item. Returns the size as dimension (object with width and height properties). * - * @param {object} nodeId the node to retrieve size for. - * @return {dimension} the size of the menu item. + * @param {Object} menuItemId the id to retrieve size for. + * @return {Dimension} the size of the menu item. */ -function getSize(nodeId) { +function getSize(menuItemId) { } /** * Init the menu setting the root menuItems. * * @public - * @param {Array<{id: String|Number, text: String=, styleClass: String=, iconStyleClass: String=, enabled: Boolean=, data: Object=, menuItems: Array=, isDivider : Boolean=}>} menuItems is an array of MenuItem objects. + * @param {Array>} menuItems is an array of MenuItem objects. + * A MenuItem type is like this {{id: String|Number, text: String=, styleClass: String=, iconStyleClass: String=, enabled: Boolean=, data: Object=, menuItems: Array=, isDivider : Boolean=}} * Each MenuItem object should set the required properties 'id', which uniquely identifies the menuItem object in menu, and 'text' property. * The MenuItem may contain the optional properties 'styleClass', 'iconStyleClass', 'data', 'enabled', 'menuItems', 'isDivider' * @@ -106,9 +105,8 @@ function getRootMenuItems() { * Returns the menuItem object * @public * - * @param {String|Number} menuItemId - * - * @return {CustomType} + * @param {String|Number} menuItemId The unique identifier of the menu item to retrieve. + * @return {CustomType} The menu item object corresponding to the specified `menuItemId`. */ function getMenuItem(menuItemId) { } @@ -117,9 +115,8 @@ function getMenuItem(menuItemId) { * Returns the parent menuItem object of the menu item with id menuItemId * @public * - * @param {String|Number} menuItemId - * - * @return {CustomType} + * @param {String|Number} menuItemId The unique identifier of the menu item whose parent menu item is to be retrieved. + * @return {CustomType} The parent menu item object of the specified `menuItemId`. */ function getParentMenuItem(menuItemId) { } @@ -129,10 +126,10 @@ function getParentMenuItem(menuItemId) { * Return false if menuItemId cannot be found. * @public * - * @param {String|Number} menuItemId - * @param {Boolean} enabled + * @param {String|Number} menuItemId The unique identifier of the menu item to enable or disable. + * @param {Boolean} enabled A boolean value where `true` enables the menu item and `false` disables it. * - * @return {Boolean} + * @return {Boolean} Returns `false` if the `menuItemId` cannot be found, otherwise `true` indicating the operation was successful. */ function setMenuItemEnabled(menuItemId, enabled) { } @@ -143,8 +140,8 @@ function setMenuItemEnabled(menuItemId, enabled) { * Return false if menuItemId cannot be found. * @public * - * @return {Array>} menuItem <<<<<<<< add description for this return <<<<<<<< - * @param {Object} [menuItemId] add the item as subMenuItem of the menuItemId. Default add the menuItem as root. + * @param {CustomType} menuItem An array containing the menu item(s) to be added. Each menu item should include properties such as `id`, `text`, `styleClass`, `iconStyleClass`, `data`, and optionally `menuItems` for nested sub-menu items. + * @param {String|Number} [menuItemId] add the item as subMenuItem of the menuItemId. Default add the menuItem as root. * @param {Number} [index] 0-based. The index at which to insert the item. Index value should not be greater then number of sibelings. Default is at the end. * * @example
 var menuItem = {
@@ -162,7 +159,7 @@ function setMenuItemEnabled(menuItemId, enabled) {
   };
   elements.sideNavigation.addMenuItem(menuItem, 1, 0);
* - * @return {Boolean} + * @return {Boolean} Returns `false` if the `menuItemId` cannot be found, otherwise `true` indicating the menu item was successfully added. * */ function addMenuItem(menuItem, menuItemId, index) { } @@ -183,8 +180,8 @@ function removeMenuItem(menuItemId) { * Returns the sub menu items of the menu item with id 'menuItemId' * @public * -* @param {String|Number} menuItemId -* @return {Array>} +* @param {String|Number} menuItemId The unique identifier of the menu item whose sub-menu items are to be retrieved. +* @return {Array>} An array of sub-menu items for the specified menu item. */ function getSubMenuItems(menuItemId) { } @@ -194,9 +191,8 @@ function getSubMenuItems(menuItemId) { * Return false if menuItemId cannot be found. * @public * - * @param {Object} menuItemId <<<<<<<< add description for this param <<<<<<<< + * @param {String|Number} menuItemId The unique identifier of the menu item to which the provided sub-menu items should be added. * @param {Array>} menuItems String|Number, text: String=, styleClass: String=, iconStyleClass: String=, enabled: Boolean=, data: Object=, menuItems: Array=, isDivider : Boolean=}>} menuItems is an array of MenuItem objects. - * @param {Array<{id: String|Number, text: String=, styleClass: String=, iconStyleClass: String=, enabled: Boolean=, data: Object=, menuItems: Array=, isDivider : Boolean=}>} menuItems is an array of MenuItem objects. * Each MenuItem object should set the required properties 'id', which uniquely identifies the menuItem object in menu, and 'text' property. * The MenuItem may contain the optional properties 'styleClass', 'iconStyleClass', 'data', 'enabled', 'menuItems', 'isDivider'. * @@ -219,7 +215,7 @@ function getSubMenuItems(menuItemId) { * }]; * elements.sideNavigation.setSubMenuItems(menuItems); * - * @return {Boolean} + * @return {Boolean} Returns `false` if the `menuItemId` cannot be found, otherwise `true` indicating the sub-menu items were successfully set. */ function setSubMenuItems(menuItemId, menuItems) { } @@ -229,9 +225,9 @@ function setSubMenuItems(menuItemId, menuItems) { * Return false if menuItemId cannot be found. * @public * - * @param {String|Number} menuItemId + * @param {String|Number} menuItemId The unique identifier of the menu item whose sub-menu items are to be removed. * - * @return {Boolean} + * @return {Boolean} True if the sub-menu items were successfully set; false if the specified menuItemId could not be found. */ function removeSubMenuItems(menuItemId) { } @@ -262,7 +258,7 @@ function clearMenuItems(depth) { * * @param {Number} [level] if level is provided search for the selected menu item at level. * - * @return {CustomType} + * @return {CustomType} The selected menu item object. */ function getSelectedMenuItem(level) { } @@ -274,15 +270,15 @@ function getSelectedMenuItem(level) { * Return false if menuItemId cannot be found or is disabled. * @public * - * @param {String|Number} id - * @param {Boolean} [mustExecuteOnMenuItemSelect] Force the onMenuItemSelect to be executed. Default false. + * @param {String|Number} menuItemId The unique identifier of the menu item to select. + * @param {Boolean} [mustExecuteOnMenuItemSelected] Force the onMenuItemSelect to be executed. Default false. * @param {Boolean} [mustExecuteOnMenuItemExpand] Force the onMenuItemExpand to be executed. Default false. * @param {Number} [level] reduce the search to the selected menuItem at level, if any menuItem is selected at level. * - * @return {Boolean} + * @return {Boolean} Returns `true` if the menu item is successfully selected, otherwise `false` if the `id` cannot be found or the menu item is disabled. * */ -function setSelectedMenuItem(id, mustExecuteOnMenuItemSelect, mustExecuteOnMenuItemExpand, level) { +function setSelectedMenuItem(menuItemId, mustExecuteOnMenuItemSelected, mustExecuteOnMenuItemExpand, level) { } /** @@ -290,11 +286,11 @@ function setSelectedMenuItem(id, mustExecuteOnMenuItemSelect, mustExecuteOnMenuI * Return false if menuItemId cannot be found or is disabled. * @public * - * @param {String|Number} menuItemId + * @param {String|Number} menuItemId The unique identifier of the menu item to expand or collapse. * @param {Boolean} expanded force the menuItem to expand if true, is collapsed otherwise * @param {Boolean} [mustExecuteOnMenuItemExpand] Force the onMenuItemExpand to be executed. Default false. * - * @return {Boolean} + * @return {Boolean} Returns `false` if the `menuItemId` cannot be found or is disabled, otherwise `true` indicating the operation was successful. */ function setMenuItemExpanded(menuItemId, expanded, mustExecuteOnMenuItemExpand) { } diff --git a/spinner/spinner_doc.js b/spinner/spinner_doc.js index bb7bcdfb..c2fa1332 100644 --- a/spinner/spinner_doc.js +++ b/spinner/spinner_doc.js @@ -1,7 +1,7 @@ /** * Request the focus to this field. * @example %%prefix%%%%elementName%%.requestFocus(); - * @param mustExecuteOnFocusGainedMethod (optional) if false will not execute the onFocusGained method; the default value is true + * @param {Boolean} [mustExecuteOnFocusGainedMethod] If false will not execute the onFocusGained method; the default value is true */ function requestFocus(mustExecuteOnFocusGainedMethod) { } diff --git a/table/table.spec b/table/table.spec index 83014a1e..69c598a4 100644 --- a/table/table.spec +++ b/table/table.spec @@ -214,7 +214,7 @@ }] }, "getViewPortPosition": { - "returns": "object" + "returns": "int[]" }, "getSortClass": { "parameters": [{"name": "columnIndex", "type": "int"}], @@ -242,7 +242,7 @@ }, "newColumn": { "parameters": [{ - "name": "dataprovider", + "name": "dataproviderid", "type": "string" },{ "name": "index", diff --git a/table/table_doc.js b/table/table_doc.js index e50ca688..646de589 100644 --- a/table/table_doc.js +++ b/table/table_doc.js @@ -1,11 +1,15 @@ /** * Request the focus to the table html element. * @example %%prefix%%%%elementName%%.requestFocus(); - * @param mustExecuteOnFocusGainedMethod (optional) if false will not execute the onFocusGained method; the default value is true + * @param {Boolean} [mustExecuteOnFocusGainedMethod] If false will not execute the onFocusGained method; the default value is true */ function requestFocus(mustExecuteOnFocusGainedMethod) { } +/** + * Gets the start and end positions of the visible area in the viewport. + * @return {Array} An array containing two elements: the start position and the end position of the visible area. + */ function getViewPortPosition(){ } @@ -16,6 +20,7 @@ function setSelectedHeader(columnIndex) { * * @example * %%prefix%%%%elementName%%.getColumnsCount() + * @return {Number} Returns the total number of columns currently present in the table. */ function getColumnsCount() { } @@ -23,12 +28,12 @@ function getColumnsCount() { /** * Gets the column at index. Index is 0 based. * - * @param index index between 0 and columns length -1 + * @param {Number} index index between 0 and columns length -1 * * @example * %%prefix%%%%elementName%%.getColumn() * - * @return {column} + * @return {CustomType} Returns the column object at the specified index, including its properties and configurations. */ function getColumn(index) { } @@ -36,13 +41,13 @@ function getColumn(index) { /** * Adds new column at specified index. Index is 0 based. * - * @param dataproviderid dataprovider of the column - * @param index index between 0 and columns length + * @param {String} dataproviderid dataprovider of the column + * @param {Number} [index] index between 0 and columns length * * @example * var column = %%prefix%%%%elementName%%.newColumn('dataproviderid') * - * @return {column} + * @return {CustomType} Returns the newly added column object. */ function newColumn(dataproviderid,index) { } @@ -53,9 +58,9 @@ function newColumn(dataproviderid,index) { * @example * %%prefix%%%%elementName%%.removeColumn(0) * - * @param index index between 0 and columns length -1 + * @param {Number} index Index index between 0 and columns length -1 * - * @return {boolean} + * @return {boolean} Returns `true` if the column was successfully removed, otherwise `false`. */ function removeColumn(index) { } @@ -66,7 +71,23 @@ function removeColumn(index) { * @example * %%prefix%%%%elementName%%.removeAllColumns() * - * @return {boolean} + * @return {Boolean} Returns `true` if all columns were successfully removed, otherwise `false`. */ function removeAllColumns() { +} + +/** + * Sets the selected header column by triggering a header click event for the specified column index. + * @param {Number} columnIndex The index of the column to set as selected. + */ +function setSelectedHeader() { +} + +/** + * Determines the CSS class for the sorting indicator of a given column. + * + * @param {Number} columnIndex The index of the column for which to retrieve the sort class. + * @return {String} The CSS class representing the sort direction (ascending, descending, or hidden) for the specified column. + */ +function getSortClass() { } \ No newline at end of file diff --git a/textfieldgroup/textfieldgroup_doc.js b/textfieldgroup/textfieldgroup_doc.js index 505c319d..f2f792ab 100644 --- a/textfieldgroup/textfieldgroup_doc.js +++ b/textfieldgroup/textfieldgroup_doc.js @@ -1,10 +1,14 @@ /** * Request the focus to this field. * @example %%prefix%%%%elementName%%.requestFocus(); - * @param mustExecuteOnFocusGainedMethod (optional) if false will not execute the onFocusGained method; the default value is true + * @param {Boolean} [mustExecuteOnFocusGainedMethod] If false will not execute the onFocusGained method; the default value is true */ function requestFocus(mustExecuteOnFocusGainedMethod) { } +/** + * Checks whether the current input is a valid email address or if the input is empty. + * @return {boolean} Returns true if the input is valid (i.e., it is a valid email address or the input is empty); otherwise, false. + */ function isValid() { } \ No newline at end of file diff --git a/treeview/treeview.spec b/treeview/treeview.spec index 3a222b72..ded2e332 100644 --- a/treeview/treeview.spec +++ b/treeview/treeview.spec @@ -165,7 +165,7 @@ "type":"object" } ], - "returns": "object" + "returns": "object[]" }, "getParentNode": { @@ -189,7 +189,7 @@ }, "getRootNodes": { - "returns": "object" + "returns": "object[]" }, "filterNodes": { "parameters":[ diff --git a/treeview/treeview_doc.js b/treeview/treeview_doc.js index aa29188f..62417caa 100644 --- a/treeview/treeview_doc.js +++ b/treeview/treeview_doc.js @@ -4,7 +4,9 @@ * * @example * %%elementName%%.refresh() - * + * + * @param {Boolean} restoreExpandedNodes Indicates whether the previously expanded nodes should be restored after the tree is refreshed. + * Set to `true` to restore expanded nodes, or `false` to collapse all nodes. */ function refresh(restoreExpandedNodes) { } @@ -16,7 +18,7 @@ function refresh(restoreExpandedNodes) { * @example * %%elementName%%.expandAll * - * @return {Boolean} +* @return {Boolean} Returns `true` if all nodes were successfully expanded, otherwise `false`. * */ function expandAll() { @@ -28,7 +30,7 @@ function expandAll() { * @example * %%elementName%%.collapseAll() * - * @return {Boolean} + * @return {Boolean} Returns `true` if all nodes were successfully collapsed, otherwise `false`. */ function collapseAll() { } @@ -39,7 +41,7 @@ function collapseAll() { * @example * %%elementName%%.expandNode(22) * - * @param nodeId node id + * @param {Object} nodeId The identifier of the node to expand. * */ function expandNode(nodeId) { @@ -51,9 +53,9 @@ function expandNode(nodeId) { * @example * var expanded = %%elementName%%.isNodeExpanded([22]) * - * @param pk array of each level id + * @param {Object} nodeId Array of each level id * - * @return {boolean} + * @return {Boolean} Returns `true` if the specified node is expanded, otherwise `false`. */ function isNodeExpanded(nodeId) { } @@ -64,7 +66,7 @@ function isNodeExpanded(nodeId) { * @example * %%elementName%%.collapseNode(22) * - * @param nodeId node id + * @param {Object} nodeId The identifier of the node to collapse. * */ function collapseNode(nodeId) { @@ -76,7 +78,7 @@ function collapseNode(nodeId) { * @example * %%elementName%%.setSelectedNode(22) * - * @param nodeId node id + * @param {Object} nodeId The identifier of the node to set as selected. */ function setSelectedNode(nodeId) { } @@ -87,7 +89,7 @@ function setSelectedNode(nodeId) { * @example * var selection = %%elementName%%.getSeletedNode() * - * @return {Object} + * @return {Object} Returns the selected node object, including its `id` and any other relevant properties. */ function getSeletedNode() { } @@ -98,9 +100,8 @@ function getSeletedNode() { * @example * var childNodes = %%elementName%%.getChildNodes() * - * @param nodeId node id - * - * @return {Array} + * @param {Object} nodeId The identifier of the parent node whose child node IDs are to be retrieved. + * @return {Array} Returns an array of objects representing the IDs of the child nodes for the specified parent node. */ function getChildNodes(nodeId) { } @@ -111,9 +112,9 @@ function getChildNodes(nodeId) { * @example * var childNodes = %%elementName%%.getChildNodes() * - * @param nodeId node id + * @param {Object} nodeId The identifier of the parent node whose child node IDs are to be retrieved. * - * @return {Object} + * @return {Object} Returns an object containing the IDs of the child nodes for the specified parent node. */ function getParentNode(nodeId) { } @@ -124,9 +125,8 @@ function getParentNode(nodeId) { * @example * var nodeLevel = %%elementName%%.getNodeLevel() * - * @param nodeId node id - * - * @return {int} + * @param {Object} nodeId The identifier of the node whose level is to be determined. + * @return {Number} Returns the level of the specified node within the tree structure, where the root level is typically 0. */ function getNodeLevel(nodeId) { } @@ -137,7 +137,7 @@ function getNodeLevel(nodeId) { * @example * var rootNodes = %%elementName%%.getRootNodes() * - * @return {Array} + * @return {Array} Returns an array of objects representing the IDs of the root nodes in the tree structure. */ function getRootNodes() { } @@ -196,7 +196,7 @@ function filterBranches(text, options) { /** * Sets the tree data - * @param jsDataSet the JSDataSet used for the tree model + * @param {JSDataset} jsDataSet the JSDataSet used for the tree model * @example * var treeviewDataSet = databaseManager.createEmptyDataSet( 0, ['id', 'pid', 'treeColumn', 'icon']); *