From 2242092c87c95a22307086d5a1bfa11525ab7502 Mon Sep 17 00:00:00 2001
From: Opaque02 <66582645+Opaque02@users.noreply.github.com>
Date: Sun, 20 Oct 2024 21:07:21 +1000
Subject: [PATCH] Added docs

---
 src/ui/admin-ui-handler.ts | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/src/ui/admin-ui-handler.ts b/src/ui/admin-ui-handler.ts
index 53192df3db4..cd166ffb001 100644
--- a/src/ui/admin-ui-handler.ts
+++ b/src/ui/admin-ui-handler.ts
@@ -164,7 +164,12 @@ export default class AdminUiHandler extends FormModalUiHandler {
     }
   }
 
-  // this is used to update the fields' text when loading a new admin ui handler. It uses the adminResult to update the input text fields depending on the adminMode
+  /**
+   * This is used to update the fields' text when loading in a new admin ui handler. It uses the {@linkcode adminResult}
+   * to update the input text based on the {@linkcode adminMode}. For a linking adminMode, it sets the username and discord.
+   * For a search adminMode, it sets the username. For an admin adminMode, it sets all the info from adminResult in the
+   * appropriate text boxes, and also sets the link/unlink icons for discord/google depending on the result
+   */
   private populateFields(adminMode: AdminMode, adminResult: AdminSearchInfo) {
     switch (adminMode) {
     case AdminMode.LINK: