Merge pull request #2449 from rejas/update_jsdoc

CHANGELOG.md

@@ -29,6 +29,7 @@ _This release is scheduled to be released on 2021-04-01._
 - Moving weather provider specific code and configuration into each provider and making hourly part of the interface.
 - Bump electron to v11.
 - Dont update the DOM when a module is not displayed.
+- Cleaned up jsdoc.
 
 ### Removed
 

clientonly/index.js

@@ -14,7 +14,6 @@
 		 *
 		 * @param {string} key key to look for at the command line
 		 * @param {string} defaultValue value if no key is given at the command line
-		 *
 		 * @returns {string} the value of the parameter
 		 */
 		function getCommandLineParameter(key, defaultValue = undefined) {
@@ -36,7 +35,6 @@
 	 * Gets the config from the specified server url
 	 *
 	 * @param {string} url location where the server is running.
-	 *
 	 * @returns {Promise} the config
 	 */
 	function getServerConfig(url) {
@@ -66,7 +64,7 @@
 	/**
 	 * Print a message to the console in case of errors
 	 *
-	 * @param {string} [message] error message to print
+	 * @param {string} message error message to print
 	 * @param {number} code error code for the exit call
 	 */
 	function fail(message, code = 1) {

js/main.js

@@ -440,7 +440,6 @@ var MM = (function () {
 		 * Removes a module instance from the collection.
 		 *
 		 * @param {object} module The module instance to remove from the collection.
-		 *
 		 * @returns {Module[]} Filtered collection of modules.
 		 */
 		var exceptModule = function (module) {

js/module.js

@@ -319,14 +319,16 @@ var Module = Class.extend({
 		const fallbackLanguage = languages[0];
 
 		if (languages.length === 0) {
-			return callback();
+			callback();
+			return;
 		}
 
 		const translationFile = translations[language];
 		const translationsFallbackFile = translations[fallbackLanguage];
 
 		if (!translationFile) {
-			return Translator.load(this, translationsFallbackFile, true, callback);
+			Translator.load(this, translationsFallbackFile, true, callback);
+			return;
 		}
 
 		Translator.load(this, translationFile, false, () => {

js/server.js

@@ -14,6 +14,13 @@ const helmet = require("helmet");
 const Log = require("./logger.js");
 const Utils = require("./utils.js");
 
+/**
+ * Server
+ *
+ * @param {object} config The MM config
+ * @param {Function} callback Function called when done.
+ * @class
+ */
 function Server(config, callback) {
 	const port = process.env.MM_PORT || config.port;
 

js/translator.js

@@ -107,7 +107,8 @@ var Translator = (function () {
 			Log.log(`${module.name} - Load translation${isFallback && " fallback"}: ${file}`);
 
 			if (this.translationsFallback[module.name]) {
-				return callback();
+				callback();
+				return;
 			}
 
 			loadJSON(module.file(file), (json) => {

package.json

@@ -20,7 +20,7 @@
 		"test:calendar": "node ./modules/default/calendar/debug.js",
 		"config:check": "node js/check_config.js",
 		"lint:prettier": "prettier --write **/*.{js,css,json,md,yml}",
-		"lint:js": "eslint *.js js/**/*.js modules/default/**/*.js clientonly/*.js serveronly/*.js translations/*.js vendor/*.js tests/**/*.js config/* --config .eslintrc.json --fix",
+		"lint:js": "eslint js/**/*.js modules/default/**/*.js clientonly/*.js serveronly/*.js translations/*.js vendor/*.js tests/**/*.js config/* --config .eslintrc.json --fix",
 		"lint:css": "stylelint css/main.css modules/default/**/*.css --config .stylelintrc.json --fix"
 	},
 	"repository": {
@@ -45,8 +45,8 @@
 	"devDependencies": {
 		"chai": "^4.2.0",
 		"chai-as-promised": "^7.1.1",
-		"eslint-config-prettier": "^7.1.0",
-		"eslint-plugin-jsdoc": "^31.0.6",
+		"eslint-config-prettier": "^7.2.0",
+		"eslint-plugin-jsdoc": "^31.6.0",
 		"eslint-plugin-prettier": "^3.3.1",
 		"express-basic-auth": "^1.2.0",
 		"husky": "^4.3.8",
@@ -60,7 +60,7 @@
 		"pretty-quick": "^3.1.0",
 		"sinon": "^9.2.4",
 		"spectron": "^13.0.0",
-		"stylelint": "^13.8.0",
+		"stylelint": "^13.9.0",
 		"stylelint-config-prettier": "^8.0.2",
 		"stylelint-config-standard": "^20.0.0",
 		"stylelint-prettier": "^1.1.2"
@@ -71,7 +71,7 @@
 	"dependencies": {
 		"colors": "^1.4.0",
 		"console-stamp": "^3.0.0-rc4.2",
-		"eslint": "^7.18.0",
+		"eslint": "^7.19.0",
 		"express": "^4.17.1",
 		"express-ipfilter": "^1.1.2",
 		"feedme": "^2.0.2",