kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-06-27 11:50:00 +00:00
Code Issues Projects Releases Wiki Activity

Cleanup jsdoc

Browse Source
This commit is contained in:
veeck 2021-01-06 13:17:39 +01:00 committed by rejas
parent 6fadc76fe3
commit 8c83dc9494
3 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
clientonly/index.js
View File

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

1
js/main.js
View File

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

7
js/server.js
View File

@ -14,6 +14,13 @@ const helmet = require("helmet");
const Log = require("./logger.js"); const Log = require("./logger.js");
const Utils = require("./utils.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) { function Server(config, callback) {
const port = process.env.MM_PORT || config.port; const port = process.env.MM_PORT || config.port;