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

Add typedef for Module, use it in other jsdocs

Browse Source
This commit is contained in:
rejas 2020-08-01 16:31:42 +02:00
parent 0674c0aff6
commit 522f7644a3
3 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
js/app.js
View File

@ -157,7 +157,7 @@ var App = function () {
/** /**
* Loads all modules. * Loads all modules.
* *
* @param {Array} modules All modules to be loaded * @param {Module[]} modules All modules to be loaded
* @param {Function} callback Function to be called after loading * @param {Function} callback Function to be called after loading
*/ */
var loadModules = function (modules, callback) { var loadModules = function (modules, callback) {

15
js/module.js
View File

@ -2,9 +2,11 @@
/* Magic Mirror /* Magic Mirror
* Module Blueprint. * Module Blueprint.
* @typedef {Object} Module
* *
* By Michael Teeuw https://michaelteeuw.nl * By Michael Teeuw https://michaelteeuw.nl
* MIT Licensed. * MIT Licensed.
*
*/ */
var Module = Class.extend({ var Module = Class.extend({
/********************************************************* /*********************************************************
@ -45,9 +47,8 @@ var Module = Class.extend({
/** /**
* Returns a list of scripts the module requires to be loaded. * Returns a list of scripts the module requires to be loaded.
* return Array<String> -
* *
* @returns {*[]} An array with filenames. * @returns {string[]} An array with filenames.
*/ */
getScripts: function () { getScripts: function () {
return []; return [];
@ -56,7 +57,7 @@ var Module = Class.extend({
/** /**
* Returns a list of stylesheets the module requires to be loaded. * Returns a list of stylesheets the module requires to be loaded.
* *
* @returns {*[]} An array with filenames. * @returns {string[]} An array with filenames.
*/ */
getStyles: function () { getStyles: function () {
return []; return [];
@ -146,7 +147,7 @@ var Module = Class.extend({
* *
* @param {string} notification The identifier of the notification. * @param {string} notification The identifier of the notification.
* @param {*} payload The payload of the notification. * @param {*} payload The payload of the notification.
* @param {object} sender The module that sent the notification. * @param {Module} sender The module that sent the notification.
*/ */
notificationReceived: function (notification, payload, sender) { notificationReceived: function (notification, payload, sender) {
if (sender) { if (sender) {
@ -212,7 +213,7 @@ var Module = Class.extend({
/** /**
* Set the module data. * Set the module data.
* *
* @param {object} data The module data * @param {Module} data The module data
*/ */
setData: function (data) { setData: function (data) {
this.data = data; this.data = data;
@ -388,7 +389,7 @@ var Module = Class.extend({
* *
* @param {number} speed The speed of the hide animation. * @param {number} speed The speed of the hide animation.
* @param {Function} callback Called when the animation is done. * @param {Function} callback Called when the animation is done.
* @param {object} options Optional settings for the hide method. * @param {object} [options] Optional settings for the hide method.
*/ */
hide: function (speed, callback, options) { hide: function (speed, callback, options) {
if (typeof callback === "object") { if (typeof callback === "object") {
@ -416,7 +417,7 @@ var Module = Class.extend({
* *
* @param {number} speed The speed of the show animation. * @param {number} speed The speed of the show animation.
* @param {Function} callback Called when the animation is done. * @param {Function} callback Called when the animation is done.
* @param {object} options Optional settings for the show method. * @param {object} [options] Optional settings for the show method.
*/ */
show: function (speed, callback, options) { show: function (speed, callback, options) {
if (typeof callback === "object") { if (typeof callback === "object") {

4
js/translator.js
View File

@ -34,7 +34,7 @@ var Translator = (function () {
/** /**
* Load a translation for a given key for a given module. * Load a translation for a given key for a given module.
* *
* @param {object} module The module to load the translation for. * @param {Module} module The module to load the translation for.
* @param {string} key The key of the text to translate. * @param {string} key The key of the text to translate.
* @param {object} variables The variables to use within the translation template (optional) * @param {object} variables The variables to use within the translation template (optional)
* *
@ -92,7 +92,7 @@ var Translator = (function () {
/** /**
* Load a translation file (json) and remember the data. * Load a translation file (json) and remember the data.
* *
* @param {object} module The module to load the translation file for. * @param {Module} module The module to load the translation file for.
* @param {string} file Path of the file we want to load. * @param {string} file Path of the file we want to load.
* @param {boolean} isFallback Flag to indicate fallback translations. * @param {boolean} isFallback Flag to indicate fallback translations.
* @param {Function} callback Function called when done. * @param {Function} callback Function called when done.