Improve javadoc and error messages.

Rapha149 · Dec 13, 2024 · 8b1bfbe · 8b1bfbe
1 parent e84d32b
commit 8b1bfbe
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/api/src/main/java/de/rapha149/signgui/exception/SignGUIVersionException.java b/api/src/main/java/de/rapha149/signgui/exception/SignGUIVersionException.java
@@ -1,7 +1,7 @@
 package de.rapha149.signgui.exception;
 
 /**
- * An exception thrown when the server version is not supported by this api or the support for this version failed to load.
+ * An exception thrown when the server version is not supported by this api or an error occured during initialization.
  */
 public class SignGUIVersionException extends Exception {
 

diff --git a/api/src/main/java/de/rapha149/signgui/version/VersionMatcher.java b/api/src/main/java/de/rapha149/signgui/version/VersionMatcher.java
@@ -14,24 +14,37 @@
 import java.net.URL;
 import java.util.stream.Collectors;
 
+/**
+ * A utility class to get the version wrapper for the server version.
+ */
 public class VersionMatcher {
 
     private static boolean initialized;
     private static VersionWrapper wrapper;
 
+    /**
+     * Returns the appropriate version wrapper for the current server version.
+     * If this method is called for the first time, the wrapper is initialized beforehand.
+     *
+     * @return The {@link VersionWrapper} instance
+     * @throws SignGUIVersionException If the server version is not supported by this api or an error occured during initialization.
+     */
     public static VersionWrapper getWrapper() throws SignGUIVersionException {
         if (!initialized) {
             initialized = true;
             return wrapper = initWrapper();
         } else if (wrapper == null) {
             throw new SignGUIVersionException("The previous attempt to initialize the version wrapper failed. " +
                                               "This could be because this server version is not supported or " +
-                                              "because the support for this server version failed to load.");
+                                              "because an error occured during initialization.");
         } else {
             return wrapper;
         }
     }
 
+    /**
+     * Internal method to initialize the version wrapper.
+     */
     private static VersionWrapper initWrapper() throws SignGUIVersionException {
         String craftBukkitPackage = Bukkit.getServer().getClass().getPackage().getName();