From eb3a5574d218aac79754968454cc10f875b35904 Mon Sep 17 00:00:00 2001 From: Pascal Date: Thu, 20 Aug 2020 14:22:45 +0200 Subject: [PATCH] refactor: use correct JSDoc syntax --- src/commands/base.js | 10 +++++----- src/translator.js | 6 ------ 2 files changed, 5 insertions(+), 11 deletions(-) diff --git a/src/commands/base.js b/src/commands/base.js index 0e7022702..39367c52e 100644 --- a/src/commands/base.js +++ b/src/commands/base.js @@ -76,7 +76,7 @@ class Command { /** * Aliases for this command - * @type {string[], CommandoTranslatable} + * @type {string[] | CommandoTranslatable} */ this.aliases = info.aliases || []; if(typeof info.autoAliases === 'undefined' || info.autoAliases) { @@ -106,25 +106,25 @@ class Command { /** * Short description of the command - * @type {string, CommandoTranslatable} + * @type {string | CommandoTranslatable} */ this.description = info.description; /** * Usage format string of the command - * @type {string, CommandoTranslatable} + * @type {string | CommandoTranslatable} */ this.format = info.format || null; /** * Long description of the command - * @type {?string, ?CommandoTranslatable} + * @type {?string | ?CommandoTranslatable} */ this.details = info.details || null; /** * Example usage strings - * @type {?string[], ?CommandoTranslatable} + * @type {?string[] | ?CommandoTranslatable} */ this.examples = info.examples || null; diff --git a/src/translator.js b/src/translator.js index 57d85c03e..8e28c8370 100644 --- a/src/translator.js +++ b/src/translator.js @@ -155,15 +155,9 @@ class CommandoTranslatable { /** * @typedef {Object} CommandoTranslatable - Represents a string which can be translated * @property {string} key - The key which will be resolved. - * @function {string} key - Getter for the key */ constructor(key) { - /** - * The key to identify the translation string - * @type {string} - * @private - */ this._key = key; }