From c49bbe0081aafee20f6eed3ae4f56b766c1aa9d8 Mon Sep 17 00:00:00 2001
From: Dmitry Gorelenkov <dmitry.gorelenkov@gmx.net>
Date: Wed, 11 Mar 2020 19:47:38 +0100
Subject: [PATCH] chore(jsdoc): fixed comments for functions in logger.ts and
 util.ts

---
 lib/logger.ts | 10 ++++++----
 lib/util.ts   |  4 ++--
 2 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/lib/logger.ts b/lib/logger.ts
index 12f007b1e..cf5b401bb 100644
--- a/lib/logger.ts
+++ b/lib/logger.ts
@@ -83,7 +83,7 @@ export class Logger {
 
   /**
    * Log INFO
-   * @param ...msgs multiple arguments to be logged.
+   * @param msgs multiple arguments to be logged.
    */
   info(...msgs: any[]): void {
     this.log_(LogLevel.INFO, msgs);
@@ -91,7 +91,7 @@ export class Logger {
 
   /**
    * Log DEBUG
-   * @param ...msgs multiple arguments to be logged.
+   * @param msgs multiple arguments to be logged.
    */
   debug(...msgs: any[]): void {
     this.log_(LogLevel.DEBUG, msgs);
@@ -99,7 +99,7 @@ export class Logger {
 
   /**
    * Log WARN
-   * @param ...msgs multiple arguments to be logged.
+   * @param msgs multiple arguments to be logged.
    */
   warn(...msgs: any[]): void {
     this.log_(LogLevel.WARN, msgs);
@@ -107,7 +107,7 @@ export class Logger {
 
   /**
    * Log ERROR
-   * @param ...msgs multiple arguments to be logged.
+   * @param msgs multiple arguments to be logged.
    */
   error(...msgs: any[]): void {
     this.log_(LogLevel.ERROR, msgs);
@@ -221,6 +221,7 @@ export class Logger {
   /**
    * Get the identifier of the logger as '/<id>'
    * @param logLevel The log level of the message.
+   * @param id not used yet
    * @param writeTo The enum for where to write the logs.
    * @return The string of the formatted id
    */
@@ -239,6 +240,7 @@ export class Logger {
   /**
    * Get the log level formatted with the first letter. For info, it is I.
    * @param logLevel The log level of the message.
+   * @param id not used yet
    * @param writeTo The enum for where to write the logs.
    * @return The string of the formatted log level
    */
diff --git a/lib/util.ts b/lib/util.ts
index 58e34cc96..510730025 100644
--- a/lib/util.ts
+++ b/lib/util.ts
@@ -31,7 +31,7 @@ export function filterStackTrace(text: string): string {
 /**
  * Internal helper for abstraction of polymorphic filenameOrFn properties.
  * @param {object} filenameOrFn The filename or function that we will execute.
- * @param {Array.<object>}} args The args to pass into filenameOrFn.
+ * @param {Array.<object>} args The args to pass into filenameOrFn.
  * @return {Promise} A promise that will resolve when filenameOrFn completes.
  */
 export async function runFilenameOrFn_(
@@ -82,7 +82,7 @@ export function joinTestLogs(log1: any, log2: any): any {
  * Returns false if an error indicates a missing or stale element, re-throws
  * the error otherwise
  *
- * @param {*} The error to check
+ * @param {*} error The error to check
  * @throws {*} The error it was passed if it doesn't indicate a missing or stale
  *   element
  * @return {boolean} false, if it doesn't re-throw the error