Documentation (23/44, 0/35)

1 files changed, 38 insertions, 1 deletions

diff --git a/src/main/java/shcm/shsupercm/fabric/citresewn/config/CITResewnConfig.java b/src/main/java/shcm/shsupercm/fabric/citresewn/config/CITResewnConfig.java
index 2f051f0..cd66fed 100644
--- a/src/main/java/shcm/shsupercm/fabric/citresewn/config/CITResewnConfig.java
+++ b/src/main/java/shcm/shsupercm/fabric/citresewn/config/CITResewnConfig.java
@@ -2,22 +2,54 @@ package shcm.shsupercm.fabric.citresewn.config;
 
 import com.google.gson.Gson;
 import com.google.gson.stream.JsonWriter;
+import net.fabricmc.loader.api.FabricLoader;
 import org.apache.commons.io.IOUtils;
 import shcm.shsupercm.fabric.citresewn.CITResewn;
 
 import java.io.*;
 
+/**
+ * Contains runtime representation of CIT Resewn's config, encoded using GSON.
+ */
 public class CITResewnConfig {
+    /**
+     * Whether CIT Resewn should work or not.<br>
+     * Requires a restart.
+     */
     public boolean enabled = true;
+    /**
+     * Mutes pack loading errors from logs.
+     */
     public boolean mute_errors = false;
+    /**
+     * Mutes pack loading warnings from logs.
+     */
     public boolean mute_warns = false;
+    /**
+     * Invalidating interval for CITs' caches in milliseconds. Set to 0 to disable caching.
+     */
     public int cache_ms = 50;
+    /**
+     * Should broken paths be allowed in resourcepacks. Requires a restart.
+     * @see BrokenPaths
+     */
     public boolean broken_paths = false;
 
-    private static final File FILE = new File("config/citresewn.json");
+    /**
+     * CIT Resewn's config storage file.
+     */
+    private static final File FILE = new File(FabricLoader.getInstance().getConfigDir().toFile(), "citresewn.json");
 
+    /**
+     * Active instance of the current config.
+     */
     public static final CITResewnConfig INSTANCE = read();
 
+    /**
+     * Reads the stored config.
+     * @see #FILE
+     * @return the read config
+     */
     public static CITResewnConfig read() {
         if (!FILE.exists())
             return new CITResewnConfig().write();
@@ -33,6 +65,11 @@ public class CITResewnConfig {
         }
     }
 
+    /**
+     * Saves this config to file.
+     * @see #FILE
+     * @return this
+     */
     public CITResewnConfig write() {
         Gson gson = new Gson();
         JsonWriter writer = null;