From 3174d9f21f471252d2a39b8cb085eeeb5debe0a6 Mon Sep 17 00:00:00 2001 From: Matthias Osswald Date: Thu, 23 Apr 2020 14:27:22 +0200 Subject: [PATCH] [FIX] Namespaces in API Reference (JSDoc) --- index.js | 6 +++--- lib/normalizer.js | 1 + lib/translators/ui5Framework.js | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/index.js b/index.js index 3cdf7eed9..7c449e55a 100644 --- a/index.js +++ b/index.js @@ -7,7 +7,7 @@ const modules = { projectPreprocessor: "./lib/projectPreprocessor", /** * @public - * @see module:@ui5/project.ui5Framework + * @alias module:@ui5/project.ui5Framework * @namespace */ ui5Framework: { @@ -16,7 +16,7 @@ const modules = { }, /** * @public - * @see module:@ui5/project.validation + * @alias module:@ui5/project.validation * @namespace */ validation: { @@ -25,7 +25,7 @@ const modules = { }, /** * @private - * @see module:@ui5/project.translators + * @alias module:@ui5/project.translators * @namespace */ translators: { diff --git a/lib/normalizer.js b/lib/normalizer.js index 2d3d2d461..e3af65ea1 100644 --- a/lib/normalizer.js +++ b/lib/normalizer.js @@ -21,6 +21,7 @@ const Normalizer = { * @param {string} [options.translatorName] Translator to use * @param {Object} [options.translatorOptions] Options to pass to translator * @param {Object} [options.frameworkOptions] Options to pass to the framework installer + * @param {string} [options.frameworkOptions.versionOverride] Framework version to use instead of the root projects framework * @returns {Promise} Promise resolving to tree object */ generateProjectTree: async function(options = {}) { diff --git a/lib/translators/ui5Framework.js b/lib/translators/ui5Framework.js index 7399d3a86..89dc08844 100644 --- a/lib/translators/ui5Framework.js +++ b/lib/translators/ui5Framework.js @@ -119,7 +119,7 @@ module.exports = { * @public * @param {Object} tree * @param {Object} [options] - * @param {Object} [options.versionOverride] Framework version to use instead of the root projects framework + * @param {string} [options.versionOverride] Framework version to use instead of the root projects framework * version from the provided tree * @returns {Promise} Promise */