Adopt JSDoc

SAP · Mar 9, 2020 · c151c9d · c151c9d
1 parent ae5d32d
commit c151c9d
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/lib/ui5Framework/AbstractResolver.js b/lib/ui5Framework/AbstractResolver.js
@@ -13,7 +13,7 @@ class AbstractResolver {
 	 * @param {*} options options
 	 * @param {string} options.version version
 	 * @param {string} [options.cwd=process.cwd()] cwd
-	 * @param {string} [options.ui5HomeDir="~/.ui5"] UI5 home dir
+	 * @param {string} [options.ui5HomeDir="~/.ui5"] UI5 home dir. Relative to `process.cwd()`
 	 */
 	constructor({cwd, version, ui5HomeDir}) {
 		if (new.target === AbstractResolver) {

diff --git a/lib/ui5Framework/Openui5Resolver.js b/lib/ui5Framework/Openui5Resolver.js
@@ -13,7 +13,7 @@ class Openui5Resolver extends AbstractResolver {
 	 * @param {*} options options
 	 * @param {string} options.version version
 	 * @param {string} [options.cwd=process.cwd()] cwd
-	 * @param {string} [options.ui5HomeDir=os.homedir()] UI5 home dir
+	 * @param {string} [options.ui5HomeDir="~/.ui5"] UI5 home dir. Relative to `process.cwd()`
 	 */
 	constructor(options) {
 		super(options);

diff --git a/lib/ui5Framework/Sapui5Resolver.js b/lib/ui5Framework/Sapui5Resolver.js
@@ -17,7 +17,7 @@ class Sapui5Resolver extends AbstractResolver {
 	 * @param {*} options options
 	 * @param {string} options.version version
 	 * @param {string} [options.cwd=process.cwd()] cwd
-	 * @param {string} [options.ui5HomeDir=os.homedir()] UI5 home dir
+	 * @param {string} [options.ui5HomeDir="~/.ui5"] UI5 home dir. Relative to `process.cwd()`
 	 */
 	constructor(options) {
 		super(options);