From 004c4ada209cd7e86f00a795565a7084bf7c88eb Mon Sep 17 00:00:00 2001
From: Rinat Khaziev <rinat.khaziev@gmail.com>
Date: Mon, 11 Dec 2023 14:53:08 -0600
Subject: [PATCH] Add docblocks

---
 src/lib/base-command.ts | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/src/lib/base-command.ts b/src/lib/base-command.ts
index 5dcc387ab..99ca438e4 100644
--- a/src/lib/base-command.ts
+++ b/src/lib/base-command.ts
@@ -73,6 +73,14 @@ export abstract class BaseVIPCommand {
 		return true;
 	}
 
+	/**
+	 * Authentication routine.
+	 * This will prompt the user to authenticate with their VIP account.
+	 *
+	 * @protected
+	 * @returns {Promise< void >}
+	 * @memberof BaseVIPCommand
+	 */
 	protected async authenticate(): Promise< void > {
 		/**
 		 * @param {any[]} argv
@@ -203,6 +211,14 @@ export abstract class BaseVIPCommand {
 
 	// args length can vary based the number of arguments and options the command defines, the command itsrlf is always the last argument
 	// Can some of this logic be moved out to a hook?
+
+	/**
+	 * This is a wrapper method that performs common routines before and after executing the command
+	 *
+	 * @param {...unknown[]} args
+	 * @returns {Promise< void >}
+	 * @memberof BaseVIPCommand
+	 */
 	public async run( ...args: unknown[] ): Promise< void > {
 		if ( this.needsAuth ) {
 			try {