Lortseam 4 years ago
parent
commit
952b9b97b0

+ 2 - 1
lib/src/main/java/me/lortseam/completeconfig/api/ConfigEntry.java

@@ -6,7 +6,8 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
- * Applied to declare that a field should be resolved as config entry.
+ * Applied to declare that a field should be resolved as config entry, using the parameters specified in this
+ * annotation.
  *
  * @see ConfigEntries
  */

+ 2 - 0
lib/src/main/java/me/lortseam/completeconfig/data/Config.java

@@ -84,6 +84,8 @@ public class Config extends BaseCollection {
 
     /**
      * Loads the config.
+     *
+     * <p>On first load, this also resolves the config's children.
      */
     public final void load() {
         if (resolver != null) {

+ 3 - 0
lib/src/main/java/me/lortseam/completeconfig/data/EntryOrigin.java

@@ -11,6 +11,9 @@ import java.lang.reflect.Field;
 import java.lang.reflect.Type;
 import java.util.Optional;
 
+/**
+ * The origin of a config entry.
+ */
 @EqualsAndHashCode(onlyExplicitlyIncluded = true)
 public final class EntryOrigin {
 

+ 2 - 2
lib/src/main/java/me/lortseam/completeconfig/extensions/GuiExtension.java

@@ -10,11 +10,11 @@ import me.lortseam.completeconfig.gui.cloth.GuiProvider;
 public interface GuiExtension extends Extension {
 
     /**
-     * Used to register custom GUI providers.
+     * Used to register global GUI providers.
      *
      * @return an array of custom GUI providers
      *
-     * @see GuiProvider
+     * @see me.lortseam.completeconfig.gui.cloth.GuiProviderRegistry#add(GuiProvider...)
      */
     default GuiProvider[] getProviders() {
         return null;

+ 2 - 0
lib/src/main/java/me/lortseam/completeconfig/gui/cloth/GuiProviderRegistry.java

@@ -211,6 +211,8 @@ public final class GuiProviderRegistry {
      * Registers one or more custom GUI providers.
      *
      * @param providers the custom GUI providers
+     *
+     * @see GuiExtension#getProviders()
      */
     public void add(GuiProvider... providers) {
         Collections.addAll(this.providers, providers);