update utils.js

yubik9 · Apr 25, 2018 · 78f30f3 · 78f30f3
1 parent 85a594e
commit 78f30f3
Showing 1 changed file with 19 additions and 4 deletions.
diff --git a/lib/utils.js b/lib/utils.js
@@ -6,13 +6,23 @@ const path = require('path');
 let controllerDir;
 let appName;
 
-function getAppName() {
+/**
+ * returns application name
+ *
+ * The name of the application can be different and this function finds it out.
+ *
+ * @param {boolean} isInstall
+ * @returns {string}
+ */
+ function getAppName() {
     const parts = __dirname.replace(/\\/g, '/').split('/');
     return parts[parts.length - 2].split('.')[0];
 }
 
 /**
- * @param {boolean} isInstall 
+ * looks for js-controller home folder
+ *
+ * @param {boolean} isInstall
  * @returns {string}
  */
 function getControllerDir(isInstall) {
@@ -44,8 +54,13 @@ function getControllerDir(isInstall) {
     return path.dirname(controllerPath);
 }
 
-// Read controller configuration file
-function getConfig() {
+/**
+ * reads controller base settings
+ *
+ * @alias getConfig
+ * @returns {object}
+ */
+ function getConfig() {
     let configPath;
     if (fs.existsSync(
         configPath = path.join(controllerDir, 'conf', appName + '.json')