refactor: use correct JSDoc syntax

discordjs · Aug 20, 2020 · eb3a557 · eb3a557
1 parent 36d9466
commit eb3a557
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 11 deletions.
diff --git 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
@@ -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;
 	}