From c98edc37a6cad5b004c05c9dbe130f65402cf8ec Mon Sep 17 00:00:00 2001
From: lieght <49651652+BAFGdeJong@users.noreply.github.com>
Date: Fri, 28 Nov 2025 20:08:13 +0100
Subject: [PATCH] Added documentation

---
 .../app/widget/tutorial/BaseTutorialWidget.java  | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/app/src/main/java/org/toop/app/widget/tutorial/BaseTutorialWidget.java b/app/src/main/java/org/toop/app/widget/tutorial/BaseTutorialWidget.java
index 51acf14..53b3361 100644
--- a/app/src/main/java/org/toop/app/widget/tutorial/BaseTutorialWidget.java
+++ b/app/src/main/java/org/toop/app/widget/tutorial/BaseTutorialWidget.java
@@ -15,6 +15,21 @@ import org.toop.local.AppContext;
 
 import java.util.List;
 
+/**
+ * A widget base for all the tutorial widgets.
+ *
+ * <p>Usage example:
+ *
+ * <pre>{@code
+ * public class Connect4TutorialWidget extends BaseTutorialWidget {
+ *     public Connect4TutorialWidget(Runnable nextScreen) {
+ *         super(List.of(
+ *                 new ImmutablePair<>("connect4.1", ResourceManager.get("connect41.png")),
+ *                 new ImmutablePair<>("connect4.2", ResourceManager.get("connect42.png"))
+ *         ), nextScreen);
+ *     }
+ * }</pre>
+ */
 public class BaseTutorialWidget extends PopupWidget implements Updatable {
 
     private final Text tutorialText;
@@ -53,6 +68,7 @@ public class BaseTutorialWidget extends PopupWidget implements Updatable {
         update(true);
     }
 
+    // TODO Refactor if statements to make code easier to read.
     public void update(boolean next) {
         pageIndex = next ? pageIndex + 1 : pageIndex - 1;