From 8da380365123891e2f9299c1d4fe790d35d1b74c Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Mon, 30 Dec 2019 00:29:59 +0100 Subject: [PATCH] improve docblocks --- Model/Action/Dom/Datalist/Append.js | 6 +++--- Model/Action/Dom/Datalist/Clear.js | 6 +++--- Model/Action/Dom/Focus.js | 8 ++++++++ Model/Action/Dom/GetValue.js | 4 ++-- Model/Action/Dom/Hide.js | 8 ++++++++ Model/Action/Dom/Popup.js | 6 +++--- Model/Action/Dom/Reload.js | 6 +++--- Model/Action/Dom/Remove.js | 6 +++--- Model/Action/Dom/RemoveValue.js | 6 +++--- Model/Action/Dom/SetValue.js | 6 +++--- Model/Action/Dom/Show.js | 11 ++++++++++- Model/Action/Dom/Table/Append.js | 4 ++-- Model/Action/Dom/Table/Clear.js | 4 ++-- Model/Action/Event/Prevent.js | 4 ++-- Model/Action/Message/Log.js | 5 +++-- Model/Action/Message/Request.js | 1 - Model/Action/Utils/DataCollector.js | 2 +- Model/Action/Utils/Timer.js | 4 ++-- Model/Action/Validate/Keypress.js | 4 ++-- Model/Message/DomActionType.js | 8 ++++++++ Model/Message/FormValidation.js | 2 +- Model/Message/Notify.js | 2 +- Model/Message/NotifyType.js | 8 ++++++++ Model/Message/Redirect.js | 2 +- Model/Message/Reload.js | 2 +- 25 files changed, 83 insertions(+), 42 deletions(-) diff --git a/Model/Action/Dom/Datalist/Append.js b/Model/Action/Dom/Datalist/Append.js index 4a1dcc6..9c832ff 100644 --- a/Model/Action/Dom/Datalist/Append.js +++ b/Model/Action/Dom/Datalist/Append.js @@ -1,8 +1,8 @@ /** - * Set message. + * Append datalist element. * - * @param {{id:string},{data:object},{text:string},{value:string}} action Message data - * @param {function} callback Callback + * @param {{id:string},{data:object},{text:string},{value:string}} action Message data + * @param {function} callback Callback * * @since 1.0.0 */ diff --git a/Model/Action/Dom/Datalist/Clear.js b/Model/Action/Dom/Datalist/Clear.js index 8f78f0e..46795ed 100644 --- a/Model/Action/Dom/Datalist/Clear.js +++ b/Model/Action/Dom/Datalist/Clear.js @@ -1,8 +1,8 @@ /** - * Set message. + * Clear datalist. * - * @param {{id:string}} action Message data - * @param {function} callback Callback + * @param {{id:string}} action Message data + * @param {function} callback Callback * * @since 1.0.0 */ diff --git a/Model/Action/Dom/Focus.js b/Model/Action/Dom/Focus.js index 41a25b6..8ff1227 100644 --- a/Model/Action/Dom/Focus.js +++ b/Model/Action/Dom/Focus.js @@ -1,3 +1,11 @@ +/** + * Focus an element. + * + * @param {Object} action Action data + * @param {function} callback Callback + * + * @since 1.0.0 + */ export function focusAction (action, callback) { "use strict"; diff --git a/Model/Action/Dom/GetValue.js b/Model/Action/Dom/GetValue.js index d66aa7c..017f14d 100644 --- a/Model/Action/Dom/GetValue.js +++ b/Model/Action/Dom/GetValue.js @@ -1,9 +1,9 @@ /** * Get value from dom. * - * @param {Object} action Action data + * @param {Object} action Action data * @param {function} callback Callback - * @param {string} id Action element + * @param {string} id Action element * * @since 1.0.0 */ diff --git a/Model/Action/Dom/Hide.js b/Model/Action/Dom/Hide.js index 0011ff1..d46b2d9 100644 --- a/Model/Action/Dom/Hide.js +++ b/Model/Action/Dom/Hide.js @@ -1,3 +1,11 @@ +/** + * Hide an element. + * + * @param {Object} action Action data + * @param {function} callback Callback + * + * @since 1.0.0 + */ export function hideAction (action, callback) { "use strict"; diff --git a/Model/Action/Dom/Popup.js b/Model/Action/Dom/Popup.js index e62f670..4667c71 100644 --- a/Model/Action/Dom/Popup.js +++ b/Model/Action/Dom/Popup.js @@ -1,9 +1,9 @@ /** - * Set message. + * Show popup. * - * @param {Object} action Action data + * @param {Object} action Action data * @param {function} callback Callback - * @param {id} element Action element + * @param {string} id Action element * * @since 1.0.0 */ diff --git a/Model/Action/Dom/Reload.js b/Model/Action/Dom/Reload.js index b80dbcf..6fc8af8 100644 --- a/Model/Action/Dom/Reload.js +++ b/Model/Action/Dom/Reload.js @@ -1,9 +1,9 @@ /** - * Reload dom. + * Reload page. * - * @param {Object} action Action data + * @param {Object} action Action data * @param {function} callback Callback - * @param {string} id Action element + * @param {string} id Action element * * @since 1.0.0 */ diff --git a/Model/Action/Dom/Remove.js b/Model/Action/Dom/Remove.js index b3a4e7c..67c556b 100644 --- a/Model/Action/Dom/Remove.js +++ b/Model/Action/Dom/Remove.js @@ -1,9 +1,9 @@ /** - * Set message. + * Remove dom element. * - * @param {Object} action Action data + * @param {Object} action Action data * @param {function} callback Callback - * @param {string} id Action element + * @param {string} id Action element * * @since 1.0.0 */ diff --git a/Model/Action/Dom/RemoveValue.js b/Model/Action/Dom/RemoveValue.js index 5c0998e..5b4d75b 100644 --- a/Model/Action/Dom/RemoveValue.js +++ b/Model/Action/Dom/RemoveValue.js @@ -1,9 +1,9 @@ /** - * Set message. + * Remove value from input. * - * @param {Object} action Action data + * @param {Object} action Action data * @param {function} callback Callback - * @param {string} id Action element + * @param {string} id Action element * * @since 1.0.0 */ diff --git a/Model/Action/Dom/SetValue.js b/Model/Action/Dom/SetValue.js index 84929ef..89622a5 100644 --- a/Model/Action/Dom/SetValue.js +++ b/Model/Action/Dom/SetValue.js @@ -1,9 +1,9 @@ /** - * Set message. + * Set value of input. * - * @param {Object} action Action data + * @param {Object} action Action data * @param {function} callback Callback - * @param {id} element Action element + * @param {string} id Action element * * @since 1.0.0 */ diff --git a/Model/Action/Dom/Show.js b/Model/Action/Dom/Show.js index d63877e..6211321 100644 --- a/Model/Action/Dom/Show.js +++ b/Model/Action/Dom/Show.js @@ -1,4 +1,13 @@ -export function showAction (action, callback) +/** + * Show dom element. + * + * @param {Object} action Action data + * @param {function} callback Callback + * @param {string} id Action element + * + * @since 1.0.0 + */ +export function showAction (action, callback, id) { "use strict"; diff --git a/Model/Action/Dom/Table/Append.js b/Model/Action/Dom/Table/Append.js index 30653fc..5bd99ab 100644 --- a/Model/Action/Dom/Table/Append.js +++ b/Model/Action/Dom/Table/Append.js @@ -1,7 +1,7 @@ /** - * Set message. + * Apped element to a table. * - * @param {Object} action Action data + * @param {Object} action Action data * @param {function} callback Callback * * @since 1.0.0 diff --git a/Model/Action/Dom/Table/Clear.js b/Model/Action/Dom/Table/Clear.js index e4d7a3b..b0a967f 100644 --- a/Model/Action/Dom/Table/Clear.js +++ b/Model/Action/Dom/Table/Clear.js @@ -1,7 +1,7 @@ /** - * Set message. + * Clear table. * - * @param {{id:string}} action Message data + * @param {Object} action Action data * @param {function} callback Callback * * @since 1.0.0 diff --git a/Model/Action/Event/Prevent.js b/Model/Action/Event/Prevent.js index f84b429..00fe5f4 100644 --- a/Model/Action/Event/Prevent.js +++ b/Model/Action/Event/Prevent.js @@ -1,9 +1,9 @@ /** * Prevent UI action. * - * @param {Object} action Action data + * @param {Object} action Action data * @param {function} callback Callback - * @param {string} id Action element + * @param {string} id Action element * * @since 1.0.0 */ diff --git a/Model/Action/Message/Log.js b/Model/Action/Message/Log.js index 808ac64..23c2ed3 100644 --- a/Model/Action/Message/Log.js +++ b/Model/Action/Message/Log.js @@ -1,12 +1,13 @@ /** * Log. * - * @param {Object} action Action data + * @param {Object} action Action data * @param {function} callback Callback + * @param {string} id Action element * * @since 1.0.0 */ -export function logAction (action, callback) +export function logAction (action, callback, id) { "use strict"; diff --git a/Model/Action/Message/Request.js b/Model/Action/Message/Request.js index 3fdbf0e..36704d9 100644 --- a/Model/Action/Message/Request.js +++ b/Model/Action/Message/Request.js @@ -1,6 +1,5 @@ import { Request } from '../../../Message/Request/Request.js'; - /** * Set message. * diff --git a/Model/Action/Utils/DataCollector.js b/Model/Action/Utils/DataCollector.js index 626bc09..b9fe5c2 100644 --- a/Model/Action/Utils/DataCollector.js +++ b/Model/Action/Utils/DataCollector.js @@ -1,7 +1,7 @@ /** * Collect data. * - * @param {Object} action Action data + * @param {Object} action Action data * @param {function} callback Callback * * @since 1.0.0 diff --git a/Model/Action/Utils/Timer.js b/Model/Action/Utils/Timer.js index 22f163d..d09f5bc 100644 --- a/Model/Action/Utils/Timer.js +++ b/Model/Action/Utils/Timer.js @@ -1,7 +1,7 @@ /** - * Set message. + * Set timer for next action. * - * @param {Object} action Action data + * @param {Object} action Action data * @param {function} callback Callback * * @since 1.0.0 diff --git a/Model/Action/Validate/Keypress.js b/Model/Action/Validate/Keypress.js index f5fd5b0..782a7d9 100644 --- a/Model/Action/Validate/Keypress.js +++ b/Model/Action/Validate/Keypress.js @@ -1,7 +1,7 @@ /** - * Validate Keypress. + * Validate keypress. * - * @param {Object} action Action data + * @param {Object} action Action data * @param {function} callback Callback * * @since 1.0.0 diff --git a/Model/Message/DomActionType.js b/Model/Message/DomActionType.js index cbdef2f..7e3b65b 100644 --- a/Model/Message/DomActionType.js +++ b/Model/Message/DomActionType.js @@ -1,3 +1,11 @@ +/** + * DOM action type. + * + * @copyright Dennis Eichhorn + * @license OMS License 1.0 + * @version 1.0.0 + * @since 1.0.0 + */ export const EnumDomActionType = Object.freeze({ CREATE_BEFORE: 0, CREATE_AFTER: 1, diff --git a/Model/Message/FormValidation.js b/Model/Message/FormValidation.js index 2d8dc15..41535c0 100644 --- a/Model/Message/FormValidation.js +++ b/Model/Message/FormValidation.js @@ -1,5 +1,5 @@ /** - * Set message. + * Form validation. * * @param {{delay:int},{errors:string},{form:string}} data Message data * diff --git a/Model/Message/Notify.js b/Model/Message/Notify.js index 2b25145..e12070f 100644 --- a/Model/Message/Notify.js +++ b/Model/Message/Notify.js @@ -1,5 +1,5 @@ /** - * Set message. + * Notification message. * * @param {{title:string},{content:string},{level:int},{delay:int},{stay:int}} data Message data * diff --git a/Model/Message/NotifyType.js b/Model/Message/NotifyType.js index 45444b3..9cc6195 100644 --- a/Model/Message/NotifyType.js +++ b/Model/Message/NotifyType.js @@ -1,3 +1,11 @@ +/** + * Notification type. + * + * @copyright Dennis Eichhorn + * @license OMS License 1.0 + * @version 1.0.0 + * @since 1.0.0 + */ export const EnumNotifyType = Object.freeze({ BINARY: 0, INFO: 1, diff --git a/Model/Message/Redirect.js b/Model/Message/Redirect.js index 1595926..a96a951 100644 --- a/Model/Message/Redirect.js +++ b/Model/Message/Redirect.js @@ -1,7 +1,7 @@ import { UriFactory } from '../../Uri/UriFactory.js'; /** - * Set message. + * Redirect. * * @param {{delay:int},{uri:string}} data Message data * diff --git a/Model/Message/Reload.js b/Model/Message/Reload.js index 820a2b9..62f37c2 100644 --- a/Model/Message/Reload.js +++ b/Model/Message/Reload.js @@ -1,5 +1,5 @@ /** - * Set message. + * Reload page. * * @param {{delay:int}} data Message data *