Merge pull request #156 from kevinthegreat1/docs

Refactors & docs

1 files changed, 15 insertions, 0 deletions

diff --git a/src/main/java/me/xmrvizzy/skyblocker/SkyblockerMod.java b/src/main/java/me/xmrvizzy/skyblocker/SkyblockerMod.java
index 503d3a64..aa10b29a 100644
--- a/src/main/java/me/xmrvizzy/skyblocker/SkyblockerMod.java
+++ b/src/main/java/me/xmrvizzy/skyblocker/SkyblockerMod.java
@@ -22,14 +22,22 @@ import net.fabricmc.api.ClientModInitializer;
 import net.fabricmc.fabric.api.client.event.lifecycle.v1.ClientTickEvents;
 import net.minecraft.client.MinecraftClient;
 
+/**
+ * Main class for Skyblocker which initializes features, registers events, and manages ticks. This class will be instantiated by Fabric. Do not instantiate this class.
+ */
 public class SkyblockerMod implements ClientModInitializer {
     public static final String NAMESPACE = "skyblocker";
     private static SkyblockerMod INSTANCE;
 
+    @SuppressWarnings("deprecation")
     public final Scheduler scheduler = new Scheduler();
     public final ContainerSolverManager containerSolverManager = new ContainerSolverManager();
     public final StatusBarTracker statusBarTracker = new StatusBarTracker();
 
+    /**
+     * Do not instantiate this class. Use {@link #getInstance()} instead.
+     */
+    @Deprecated
     public SkyblockerMod() {
         INSTANCE = this;
     }
@@ -38,6 +46,9 @@ public class SkyblockerMod implements ClientModInitializer {
         return INSTANCE;
     }
 
+    /**
+     * Register {@link #tick(MinecraftClient)} to {@link ClientTickEvents#END_CLIENT_TICK}, initialize all features, and schedule tick events.
+     */
     @Override
     public void onInitializeClient() {
         ClientTickEvents.END_CLIENT_TICK.register(this::tick);
@@ -62,6 +73,10 @@ public class SkyblockerMod implements ClientModInitializer {
         scheduler.scheduleCyclic(DwarvenHud::update, 40);
     }
 
+    /**
+     * Ticks the scheduler. Called once at the end of every client tick through {@link ClientTickEvents#END_CLIENT_TICK}.
+     * @param client the Minecraft client.
+     */
     public void tick(MinecraftClient client) {
         scheduler.tick();
     }