From 64e15ba3c2bbcc6e4b95cb3ff1fa667ce7652882 Mon Sep 17 00:00:00 2001 From: GRZ4NA Date: Sat, 21 Aug 2021 16:26:47 +0200 Subject: [PATCH] added JSDoc comments to methods that were not commented --- src/Command.ts | 7 +++++++ src/CommandManager.ts | 9 ++++++++- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/src/Command.ts b/src/Command.ts index e8ece4a..b8abb26 100644 --- a/src/Command.ts +++ b/src/Command.ts @@ -154,6 +154,10 @@ export class Command { }; } + /** + * @param {string|string[]} phrase? + * @returns string + */ private static processPhrase(phrase?: string | string[]): string[] | undefined { if (Array.isArray(phrase)) { const buff = phrase.map((p) => { @@ -174,6 +178,9 @@ export class Command { } } + /** + * @returns string + */ private generateUsageFromArguments(): string { let usageTemplate: string = ""; this.parameters && diff --git a/src/CommandManager.ts b/src/CommandManager.ts index ece162f..4102c05 100644 --- a/src/CommandManager.ts +++ b/src/CommandManager.ts @@ -9,6 +9,10 @@ export class CommandManager { prefix?: string; argumentSeparator: string; + /** + * @param {string} prefix? + * @param {string} argumentSeparator? + */ constructor(prefix?: string, argumentSeparator?: string) { this.list = []; this.prefix = prefix; @@ -18,7 +22,6 @@ export class CommandManager { /** * Retrieves the command by name, alias or keyword * @param {string} phrase - command name, alias or keyword - * @param {GetMode} [mode='ALL'] - specifies which types of command triggers will be used to find the command [*NO_PREFIX* - only keywords; *PREFIX* - names and aliases] * @returns *Command* | *null* */ get(phrase: string): Command | null { @@ -178,6 +181,10 @@ export class CommandManager { return null; } + /** + * @param {string} phrase? + * @returns PhraseOccurrenceData + */ private findPhraseOccurrence(phrase?: string): PhraseOccurrenceData | null { let returnValue: PhraseOccurrenceData | null = null; this.list.map((c) => {