[FIX] Namespaces in API Reference (JSDoc)

SAP · Apr 24, 2020 · 3174d9f · 3174d9f
1 parent a57cb52
commit 3174d9f
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git 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
@@ -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<Object>} Promise resolving to tree object
  */
  generateProjectTree: async function(options = {}) {

diff --git 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 <code>tree</code>
  * @returns {Promise<Object|null>} Promise
  */