From f7434efeae8f4ea0d193cdad11928f5a13eb6374 Mon Sep 17 00:00:00 2001
From: Kevinthegreat <92656833+kevinthegreat1@users.noreply.github.com>
Date: Tue, 20 Jun 2023 12:25:22 +0800
Subject: Add docs

---
 .../me/xmrvizzy/skyblocker/discord/DiscordRPCManager.java    | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'src/main/java/me')

diff --git a/src/main/java/me/xmrvizzy/skyblocker/discord/DiscordRPCManager.java b/src/main/java/me/xmrvizzy/skyblocker/discord/DiscordRPCManager.java
index f7ec2f33..29a2c958 100644
--- a/src/main/java/me/xmrvizzy/skyblocker/discord/DiscordRPCManager.java
+++ b/src/main/java/me/xmrvizzy/skyblocker/discord/DiscordRPCManager.java
@@ -13,9 +13,15 @@ import org.slf4j.LoggerFactory;
 import java.text.DecimalFormat;
 import java.util.concurrent.CompletableFuture;
 
+/**
+ * Manages the discord rich presence. Automatically connects to discord and displays a customizable activity when playing Skyblock.
+ */
 public class DiscordRPCManager {
     public static final DecimalFormat DECIMAL_FORMAT = new DecimalFormat("###,###.##");
     public static final Logger LOGGER = LoggerFactory.getLogger("Skyblocker Discord RPC");
+    /**
+     * The update task used to avoid multiple update tasks running simultaneously.
+     */
     public static CompletableFuture<Void> updateTask;
     public static long startTimeStamp;
     public static int cycleCount;
@@ -28,6 +34,9 @@ public class DiscordRPCManager {
         });
     }
 
+    /**
+     * Checks the {@link SkyblockerConfig.RichPresence#customMessage custom message}, updates {@link #cycleCount} if enabled, and updates rich presence.
+     */
     public static void updateDataAndPresence() {
         // If the custom message is empty, discord will keep the last message, this is can serve as a default if the user doesn't want a custom message
         if (SkyblockerConfig.get().richPresence.customMessage.isEmpty()) {
@@ -38,6 +47,9 @@ public class DiscordRPCManager {
         initAndUpdatePresence();
     }
 
+    /**
+     * @see #initAndUpdatePresence(boolean)
+     */
     private static void initAndUpdatePresence() {
         initAndUpdatePresence(false);
     }
-- 
cgit