doc: Added documentation

Author: Mqxx

src/main/java/dev/loat/command/Command.java

@@ -8,14 +8,30 @@
 import net.minecraft.network.chat.Component;
 import net.minecraft.world.entity.player.Player;
 
+/**
+ * Represents a command.
+ */
 public class Command {
+    /**
+     * Checks if the given command context contains the given argument.
+     *
+     * @param context The command context to check.
+     * @param argument The argument to check for.
+     * @return True if the argument exists, false otherwise.
+     */
     protected static boolean hasArgument(
         CommandContext<CommandSourceStack> context,
         String argument
     ) {
         return context.getNodes().stream().anyMatch(node -> node.getNode().getName().equals(argument));
     }
 
+    /**
+     * Sends a success message to the player executing the command, if the command source is a player.
+     *
+     * @param context The command context to send the success message to.
+     * @param supplier The supplier of the success message component.
+     */
     @SuppressWarnings("null")
     protected static void sendSuccess(
         CommandContext<CommandSourceStack> context,

src/main/java/dev/loat/command/CommandManager.java

@@ -8,7 +8,15 @@
 import dev.loat.command.sub_command.*;
 import dev.loat.command.suggestion_provider.BackupFiles;
 
+/**
+ * Manages commands.
+ */
 public class CommandManager {
+    /**
+     * Registers all commands.
+     * 
+     * @implNote This method is called by fabric during the initialization process.
+     */
     @SuppressWarnings("null")
     public static void register() {
         CommandRegistrationCallback.EVENT.register((

src/main/java/dev/loat/config/Config.java

@@ -6,13 +6,23 @@
 import java.io.File;
 import java.nio.file.Path;
 
-
+/**
+ * Represents a configuration file.
+ * 
+ * @param <ConfigFile> The config file type
+ */
 public class Config<ConfigFile> {
     private final Class<ConfigFile> configFileClass;
     private final YamlSerializer<ConfigFile> serializer;
     @SuppressWarnings("null")
     private ConfigFile config = null;
 
+    /**
+     * Creates a new config instance.
+     *
+     * @param path The path to the config file
+     * @param configFileClass The config file class
+     */
     public Config(
         Path path,
         Class<ConfigFile> configFileClass
@@ -37,10 +47,27 @@ public Config(
         }
     }
 
+
+    /**
+     * Returns the config file class associated with this config.
+     *
+     * @return The config file class
+     */
     Class<ConfigFile> getConfigFileClass() {
         return this.configFileClass;
     }
 
+
+    /**
+     * Loads the configuration from the file.
+     *
+     * If the file does not exist, it will be created with default values.
+     *
+     * If an error occurs while parsing the file, it will be caught and logged.
+     * In this case, a new instance of the config class will be created using its default constructor.
+     * If an error occurs while creating a new instance of the config class, it will be caught and logged.
+     * In this case, the config will be set to null.
+     */
     @SuppressWarnings("null")
     public void load() {
         try {
@@ -58,6 +85,11 @@ public void load() {
         }
     }
 
+    /**
+     * Returns the configuration associated with this config.
+     *
+     * @return The configuration associated with this config, or null if an error occurred while parsing or creating the config.
+     */
     public ConfigFile get() {
         return this.config;
     }

src/main/java/dev/loat/config/ConfigManager.java

@@ -13,7 +13,6 @@
  * Manages configuration files.
  */
 public class ConfigManager {
-    
     public static final String path = "backup";
     private static final Map<Class<?>, Config<?>> configs = new HashMap<>();
 

src/main/java/dev/loat/config/annotation/Comment.java

@@ -5,6 +5,9 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * Indicates a comment for a configuration field.
+ */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.FIELD)
 public @interface Comment {

src/main/java/dev/loat/logging/Logger.java

@@ -12,7 +12,7 @@ public class Logger {
     /**
      * This static function is used to set the class for logging.
      *
-     * @param classInstance The instance to use for logging
+     * @param classInstance The instance to use for logging.
      */
     public static void setLoggerClass(Class<? extends ModInitializer> classInstance) {
         Logger.INSTANCE = LoggerFactory.getLogger(classInstance);
@@ -21,7 +21,7 @@ public static void setLoggerClass(Class<? extends ModInitializer> classInstance)
     /**
      * This static function is used for logging a message at debug level.
      *
-     * @param message The message to log
+     * @param message The message to log.
      */
     public static void debug(String message) {
         Logger.INSTANCE.debug(message);
@@ -30,7 +30,7 @@ public static void debug(String message) {
     /**
      * This static function is used for logging a message at info level.
      *
-     * @param message The message to log
+     * @param message The message to log.
      */
     public static void info(String message) {
         Logger.INSTANCE.info(message);
@@ -39,7 +39,7 @@ public static void info(String message) {
     /**
      * This static function is used for logging a message at warning level.
      *
-     * @param message The message to log
+     * @param message The message to log.
      */
     public static void warning(String message) {
         Logger.INSTANCE.warn(message);
@@ -48,7 +48,7 @@ public static void warning(String message) {
     /**
      * This static function is used for logging a message at error level.
      *
-     * @param message The message to log
+     * @param message The message to log.
      */
     public static void error(String message) {
         Logger.INSTANCE.error(message);