Documentation (23/44, 0/35)

1 files changed, 18 insertions, 0 deletions

diff --git a/src/main/java/shcm/shsupercm/fabric/citresewn/config/BrokenPaths.java b/src/main/java/shcm/shsupercm/fabric/citresewn/config/BrokenPaths.java
index c89e3cb..f4b2c65 100644
--- a/src/main/java/shcm/shsupercm/fabric/citresewn/config/BrokenPaths.java
+++ b/src/main/java/shcm/shsupercm/fabric/citresewn/config/BrokenPaths.java
@@ -1,5 +1,23 @@
 package shcm.shsupercm.fabric.citresewn.config;
 
+import net.minecraft.util.Identifier;
+import shcm.shsupercm.fabric.citresewn.mixin.broken_paths.*;
+
+/**
+ * Broken paths are resourcepack file paths that do not follow {@link Identifier}'s specifications.<br>
+ * When enabled in config, CIT Resewn will forcibly allow broken paths to load.<br>
+ * If not enabled, broken paths has no effect on the game.
+ * @see CITResewnConfig#broken_paths
+ * @see CITResewnMixinConfiguration#broken_paths
+ * @see ReloadableResourceManagerImplMixin
+ * @see IdentifierMixin
+ * @see AbstractFileResourcePackMixin
+ */
 public class BrokenPaths {
+    /**
+     * When enabled, {@link Identifier}s will not check for their path's validity.
+     * @see ReloadableResourceManagerImplMixin
+     * @see IdentifierMixin
+     */
     public static boolean processingBrokenPaths = false;
 }