From 46170500518e94e86758af11267fb08021d48170 Mon Sep 17 00:00:00 2001
From: Kevinthegreat <92656833+kevinthegreat1@users.noreply.github.com>
Date: Tue, 2 May 2023 18:12:56 -0400
Subject: Added Container Solver docs

---
 src/main/java/me/xmrvizzy/skyblocker/container/ContainerSolver.java    | 3 +++
 .../java/me/xmrvizzy/skyblocker/container/ContainerSolverManager.java  | 3 +++
 2 files changed, 6 insertions(+)

(limited to 'src')

diff --git a/src/main/java/me/xmrvizzy/skyblocker/container/ContainerSolver.java b/src/main/java/me/xmrvizzy/skyblocker/container/ContainerSolver.java
index ec086934..ecec2449 100644
--- a/src/main/java/me/xmrvizzy/skyblocker/container/ContainerSolver.java
+++ b/src/main/java/me/xmrvizzy/skyblocker/container/ContainerSolver.java
@@ -6,6 +6,9 @@ import java.util.List;
 import java.util.Map;
 import java.util.regex.Pattern;
 
+/**
+ * Abstract class for container solvers. Extend this class to add a new container solver, like terminal solvers or experiment solvers.
+ */
 public abstract class ContainerSolver {
     private final Pattern CONTAINER_NAME;
     protected final static int GREEN_HIGHLIGHT = 128 << 24 | 64 << 16 | 196 << 8 | 64;
diff --git a/src/main/java/me/xmrvizzy/skyblocker/container/ContainerSolverManager.java b/src/main/java/me/xmrvizzy/skyblocker/container/ContainerSolverManager.java
index 276ac3b9..b50231fb 100644
--- a/src/main/java/me/xmrvizzy/skyblocker/container/ContainerSolverManager.java
+++ b/src/main/java/me/xmrvizzy/skyblocker/container/ContainerSolverManager.java
@@ -18,6 +18,9 @@ import java.util.TreeMap;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+/**
+ * Manager class for {@link ContainerSolver}s like terminal solvers and experiment solvers. To add a new container solver, extend {@link ContainerSolver} and register it in {@link #ContainerSolverManager()}.
+ */
 public class ContainerSolverManager extends DrawableHelper {
     private static final Pattern PLACEHOLDER_PATTERN = Pattern.compile("");
     private final ContainerSolver[] solvers;
-- 
cgit