Skip to content

Commit

Permalink
[INTERNAL] Improve JSDoc param types
Browse files Browse the repository at this point in the history
  • Loading branch information
larskissel committed Jul 23, 2021
1 parent 7fe851f commit 692d93b
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions lib/utils/buildHelper.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ const log = require("@ui5/logger").getLogger("cli:utils:buildHelper");
* its value is an array of all of its transitive dependencies.
*
* @param {object} tree Project tree as generated by the [@ui5/project.normalizer]{@link module:@ui5/project.normalizer}
* @returns {object<string, string[]>} An object with dependency names as key and each with an array of its transitive
* @returns {Object<string, string[]>} An object with dependency names as key and each with an array of its transitive
* dependencies as value
*/
function getFlattenedDependencyTree(tree) {
Expand Down Expand Up @@ -40,7 +40,8 @@ function getFlattenedDependencyTree(tree) {
* transitive dependencies are handled with a lower priority than explicitly mentioned dependencies. The default
* dependencies set in the build settings are appended in the end.
*
* The priority of the various dependency lists is applied in the following order:
* The priority of the various dependency lists is applied in the following order, but note that a later list can't
* overrule earlier ones:
* <ol>
* <li>includeDependency, includeDependencyRegExp</li>
* <li>excludeDependency, excludeDependencyRegExp</li>
Expand All @@ -52,24 +53,24 @@ function getFlattenedDependencyTree(tree) {
* @param {object} parameters Parameters
* @param {object} parameters.tree Project tree as generated by the
* [@ui5/project.normalizer]{@link module:@ui5/project.normalizer}
* @param {Array.<string>} parameters.includeDependency The dependencies to be considered in 'includedDependencies'; the
* @param {string[]} parameters.includeDependency The dependencies to be considered in 'includedDependencies'; the
* "*" character can be used as wildcard for all dependencies and is an alias for the CLI option "--all"
* @param {Array.<string>} parameters.includeDependencyRegExp Strings which are interpreted as regular expressions
* @param {string[]} parameters.includeDependencyRegExp Strings which are interpreted as regular expressions
* to describe the selection of dependencies to be considered in 'includedDependencies'
* @param {Array.<string>} parameters.includeDependencyTree The dependencies to be considered in 'includedDependencies';
* @param {string[]} parameters.includeDependencyTree The dependencies to be considered in 'includedDependencies';
* transitive dependencies are also appended
* @param {Array.<string>} parameters.excludeDependency The dependencies to be considered in 'excludedDependencies'
* @param {Array.<string>} parameters.excludeDependencyRegExp Strings which are interpreted as regular expressions
* @param {string[]} parameters.excludeDependency The dependencies to be considered in 'excludedDependencies'
* @param {string[]} parameters.excludeDependencyRegExp Strings which are interpreted as regular expressions
* to describe the selection of dependencies to be considered in 'excludedDependencies'
* @param {Array.<string>} parameters.excludeDependencyTree The dependencies to be considered in 'excludedDependencies';
* @param {string[]} parameters.excludeDependencyTree The dependencies to be considered in 'excludedDependencies';
* transitive dependencies are also appended
* @param {Array.<string>} parameters.defaultIncludeDependency Same as 'includeDependency' parameter; used for build
* @param {string[]} parameters.defaultIncludeDependency Same as 'includeDependency' parameter; used for build
* settings
* @param {Array.<string>} parameters.defaultIncludeDependencyRegExp Same as 'includeDependencyRegExp' parameter; used
* @param {string[]} parameters.defaultIncludeDependencyRegExp Same as 'includeDependencyRegExp' parameter; used
* for build settings
* @param {Array.<string>} parameters.defaultIncludeDependencyTree Same as 'includeDependencyTree' parameter; used for
* @param {string[]} parameters.defaultIncludeDependencyTree Same as 'includeDependencyTree' parameter; used for
* build settings
* @returns {object<string, string[]>} An object containing the 'includedDependencies' and 'excludedDependencies'
* @returns {Object<string, string[]>} An object containing the 'includedDependencies' and 'excludedDependencies'
*/
function createDependencyLists({
tree,
Expand Down Expand Up @@ -189,8 +190,8 @@ function createDependencyLists({
*
* @param {boolean} buildAll The value of the <code>all</code> command line parameter to decide if project
* dependencies have to be built
* @param {Array.<string|RegExp>} includedDependencies The list of included dependencies
* @param {Array.<string|RegExp>} excludedDependencies The list of excluded dependencies
* @param {string[]} includedDependencies The list of included dependencies
* @param {string[]} excludedDependencies The list of excluded dependencies
* @returns {boolean} Whether it is required to build project dependencies
*/
function alignWithBuilderApi(buildAll, includedDependencies, excludedDependencies) {
Expand Down

0 comments on commit 692d93b

Please sign in to comment.