From 5a4c13e70d55dd62c8261c2d4cd04c22be17a793 Mon Sep 17 00:00:00 2001
From: MokaStitcher <millennium.stitcher@gmail.com>
Date: Mon, 16 Sep 2024 16:35:22 +0200
Subject: [PATCH] add missing doc

---
 src/tutorial.ts | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/tutorial.ts b/src/tutorial.ts
index dc442929892..28780210418 100644
--- a/src/tutorial.ts
+++ b/src/tutorial.ts
@@ -65,6 +65,14 @@ const tutorialHandlers = {
   },
 };
 
+/**
+ * Run through the specified tutorial if it hasn't been seen before and mark it as seen once done
+ * This will show a tutorial overlay if defined in the current {@linkcode AwaitableUiHandler}
+ * The main menu will also get disabled while the tutorial is running
+ * @param scene the current {@linkcode BattleScene}
+ * @param tutorial the {@linkcode Tutorial} to play
+ * @returns a promise with result true is the tutorial was run and finished, false otherwise
+ */
 export async function handleTutorial(scene: BattleScene, tutorial: Tutorial): Promise<boolean> {
   if (!scene.enableTutorials && !Overrides.BYPASS_TUTORIAL_SKIP) {
     return false;