From b3af6a8a0a42cedbd5124a4b7197e4c66cdfe560 Mon Sep 17 00:00:00 2001
From: NightKev <34855794+DayKev@users.noreply.github.com>
Date: Mon, 28 Jul 2025 14:55:52 -0700
Subject: [PATCH] Convert comments to TSDocs

---
 src/ui/move-info-overlay.ts | 22 +++++++++++++++-------
 1 file changed, 15 insertions(+), 7 deletions(-)

diff --git a/src/ui/move-info-overlay.ts b/src/ui/move-info-overlay.ts
index c23e4c11560..937c481a997 100644
--- a/src/ui/move-info-overlay.ts
+++ b/src/ui/move-info-overlay.ts
@@ -10,16 +10,24 @@ import { fixedInt, getLocalizedSpriteKey } from "#utils/common";
 import i18next from "i18next";
 
 export interface MoveInfoOverlaySettings {
-  delayVisibility?: boolean; // if true, showing the overlay will only set it to active and populate the fields and the handler using this field has to manually call setVisible later.
-  top?: boolean; // should the effect box be on top?
-  right?: boolean; // should the effect box be on the right?
-  onSide?: boolean; // should the effect be on the side? ignores top argument if true
-  //location and width of the component; unaffected by scaling
+  /**
+   * If true, showing the overlay will only set it to active and populate the fields
+   * and the handler using this field has to manually call `setVisible` later.
+   */
+  delayVisibility?: boolean;
+  /** Whether the effect box should be on top */
+  top?: boolean;
+  /** Whether the effect box should be on the right */
+  right?: boolean;
+  /** Whether the effect box should be on the side. Overrides the `top` param if `true`. */
+  onSide?: boolean;
+  /** `x` position of the component, unaffected by scaling */
   x?: number;
+  /** `y` position of the component, unaffected by scaling */
   y?: number;
-  // Default width is half the screen
+  /** Width of the component, unaffected by scaling. Defaults to half the screen width. */
   width?: number;
-  // Determines whether to display the small secondary box
+  /* Whether to display the small secondary box */
   hideEffectBox?: boolean;
   hideBg?: boolean;
 }