From 357388d49c306a288f2c56cb6f25589237f7284e Mon Sep 17 00:00:00 2001
From: Unknown <shekwancheung0528@gmail.com>
Date: Sun, 12 May 2019 01:32:04 +0800
Subject: Small documentations

---
 .../java/me/shedaniel/rei/api/ConfigManager.java   | 34 ++++++++++++++++++++++
 1 file changed, 34 insertions(+)

(limited to 'src/main/java/me/shedaniel/rei/api/ConfigManager.java')

diff --git a/src/main/java/me/shedaniel/rei/api/ConfigManager.java b/src/main/java/me/shedaniel/rei/api/ConfigManager.java
index d23429142..536d61c60 100644
--- a/src/main/java/me/shedaniel/rei/api/ConfigManager.java
+++ b/src/main/java/me/shedaniel/rei/api/ConfigManager.java
@@ -7,18 +7,52 @@ import java.io.IOException;
 
 public interface ConfigManager {
     
+    /**
+     * Saves the config.
+     *
+     * @throws IOException
+     */
     void saveConfig() throws IOException;
     
+    /**
+     * Loads the config from the json file, creates the file if not found.
+     *
+     * @throws IOException
+     */
     void loadConfig() throws IOException;
     
+    /**
+     * Gets the config instance
+     *
+     * @return the config instance
+     */
     ConfigObject getConfig();
     
+    /**
+     * Gets if craftable only filter is enabled
+     *
+     * @return whether craftable only filter is enabled
+     */
     boolean isCraftableOnlyEnabled();
     
+    /**
+     * Toggles the craftable only filter
+     */
     void toggleCraftableOnly();
     
+    /**
+     * Opens the config screen
+     *
+     * @param parent the screen shown before
+     */
     void openConfigScreen(Screen parent);
     
+    /**
+     * Gets the config screen
+     *
+     * @param parent the screen shown before
+     * @return the config screen
+     */
     Screen getConfigScreen(Screen parent);
     
 }
-- 
cgit