Add missing javadoc

Author: NichtStudioCode

invui/src/main/java/xyz/xenondevs/invui/Click.java

@@ -15,8 +15,15 @@ public record Click(
     Player player,
     ClickType clickType,
     int hotbarButton
-) {
+)
+{
 
+    /**
+     * Creates a new {@link Click} with the given player and click type.
+     *
+     * @param player    The player who clicked.
+     * @param clickType The type of click.
+     */
     public Click(Player player, ClickType clickType) {
         this(player, clickType, -1);
     }

invui/src/main/java/xyz/xenondevs/invui/InvUI.java

@@ -12,6 +12,9 @@
 import java.util.List;
 import java.util.logging.Logger;
 
+/**
+ * Main class of InvUI, managing the plugin instance.
+ */
 public class InvUI implements Listener {
 
     private static final InvUI INSTANCE = new InvUI();
@@ -22,10 +25,23 @@ public class InvUI implements Listener {
     private InvUI() {
     }
 
+    /**
+     * Returns the singleton instance of InvUI.
+     *
+     * @return the InvUI instance
+     */
     public static InvUI getInstance() {
         return INSTANCE;
     }
 
+    /**
+     * Gets the plugin instance that InvUI is running under.
+     * If possible, the plugin instance is inferred from the class loader.
+     * If this is not possible, the plugin instance must be set manually using {@link #setPlugin(Plugin)} beforehand.
+     *
+     * @return The plugin instance.
+     * @throws IllegalStateException If the plugin instance is not set and cannot be inferred.
+     */
     public Plugin getPlugin() {
         if (plugin == null) {
             setPlugin(tryFindPlugin());
@@ -52,6 +68,13 @@ public Plugin getPlugin() {
         return null;
     }
 
+    /**
+     * Sets the plugin instance that InvUI is running under.
+     * This is used to register event listeners, schedule tasks, etc.
+     *
+     * @param plugin The plugin instance to set.
+     * @throws IllegalStateException If the plugin instance is already set.
+     */
     public void setPlugin(@Nullable Plugin plugin) {
         if (this.plugin != null)
             throw new IllegalStateException("Plugin is already set");
@@ -63,10 +86,21 @@ public void setPlugin(@Nullable Plugin plugin) {
         this.plugin = plugin;
     }
 
+    /**
+     * Gets the logger of the configured plugin instance.
+     *
+     * @return The logger of the plugin instance.
+     * @throws IllegalStateException If the plugin instance is not set and cannot be inferred.
+     */
     public Logger getLogger() {
         return getPlugin().getLogger();
     }
 
+    /**
+     * Adds a {@link Runnable} that is executed when the plugin is disabled.
+     *
+     * @param runnable The runnable to execute on plugin disable.
+     */
     public void addDisableHandler(Runnable runnable) {
         disableHandlers.add(runnable);
     }

invui/src/main/java/xyz/xenondevs/invui/gui/AbstractIngredientMapper.java

@@ -13,6 +13,9 @@
 @SuppressWarnings("unchecked")
 abstract class AbstractIngredientMapper<S extends AbstractIngredientMapper<S>> implements IngredientMapper<S> {
 
+    /**
+     * Maps ingredient keys ({@link Character characters}) to their corresponding {@link Ingredient} instances.
+     */
     protected HashMap<Character, Ingredient> ingredientMap = new HashMap<>();
 
     @Override
@@ -93,6 +96,9 @@ public S clone() {
         }
     }
 
+    /**
+     * Called when the ingredient mapping is updated.
+     */
     protected void handleUpdate() {}
 
 }

invui/src/main/java/xyz/xenondevs/invui/gui/ScrollGui.java

@@ -11,7 +11,6 @@
 import java.util.List;
 import java.util.SequencedSet;
 import java.util.function.BiConsumer;
-import java.util.function.Consumer;
 
 /**
  * A {@link Gui} that displays content in lines that can be scrolled through.
@@ -36,6 +35,7 @@ static Builder<Item> itemsBuilder() {
      * @param height           The height of the {@link ScrollGui}.
      * @param items            The {@link Item Items} to use.
      * @param contentListSlots The slots where content should be displayed.
+     * @param direction        The direction in which the {@link ScrollGui} will scroll.
      * @return The created {@link ScrollGui}.
      */
     static ScrollGui<Item> ofItems(int width, int height, List<? extends Item> items, SequencedSet<Slot> contentListSlots, ScrollDirection direction) {
@@ -69,6 +69,7 @@ static Builder<Gui> guisBuilder() {
      * @param height           The height of the {@link ScrollGui}.
      * @param guis             The {@link Gui Guis} to use.
      * @param contentListSlots The slots where content should be displayed.
+     * @param direction        The direction in which the {@link ScrollGui} will scroll.
      * @return The created {@link ScrollGui}.
      */
     static ScrollGui<Gui> ofGuis(int width, int height, List<? extends Gui> guis, SequencedSet<Slot> contentListSlots, ScrollDirection direction) {
@@ -102,6 +103,7 @@ static Builder<Inventory> inventoriesBuilder() {
      * @param height           The height of the {@link ScrollGui}.
      * @param inventories      The {@link Inventory VirtualInventories} to use.
      * @param contentListSlots The slots where content should be displayed.
+     * @param direction        The direction in which the {@link ScrollGui} will scroll.
      * @return The created {@link ScrollGui}.
      */
     static ScrollGui<Inventory> ofInventories(int width, int height, List<? extends Inventory> inventories, SequencedSet<Slot> contentListSlots, ScrollDirection direction) {

invui/src/main/java/xyz/xenondevs/invui/gui/SlotElement.java

@@ -62,6 +62,12 @@ public SlotElement getHoldingElement() {
      */
     record InventoryLink(Inventory inventory, int slot, @Nullable ItemProvider background) implements SlotElement {
 
+        /**
+         * Creates a new {@link InventoryLink} using the given {@link Inventory} and slot.
+         *
+         * @param inventory The {@link Inventory} to link to
+         * @param slot      The slot in the {@link Inventory} to link to
+         */
         public InventoryLink(Inventory inventory, int slot) {
             this(inventory, slot, null);
         }

invui/src/main/java/xyz/xenondevs/invui/i18n/Languages.java

@@ -31,6 +31,10 @@ public class Languages {
     private Languages() {
     }
 
+    /**
+     * Gets the singleton instance of Languages.
+     * @return The singleton instance of Languages.
+     */
     public static Languages getInstance() {
         return INSTANCE;
     }

invui/src/main/java/xyz/xenondevs/invui/inventory/Inventory.java

@@ -224,6 +224,8 @@ public void removeViewer(AbstractWindow<?> viewer, int what, int how) {
 
     /**
      * Gets all {@link Window Windows} displaying this {@link Inventory}.
+     *
+     * @return A list of all {@link Window Windows} displaying this {@link Inventory}.
      */
     public List<Window> getWindows() {
         var windows = new ArrayList<Window>();

invui/src/main/java/xyz/xenondevs/invui/inventory/InventorySlot.java

@@ -2,6 +2,9 @@
 
 /**
  * A record encapsulating a slot of an {@link Inventory}.
+ * 
+ * @param inventory The {@link Inventory} this slot belongs to.
+ * @param slot The slot index in the {@link Inventory}.
  */
 public record InventorySlot(Inventory inventory, int slot) {
 

invui/src/main/java/xyz/xenondevs/invui/inventory/event/PlayerUpdateReason.java

@@ -29,6 +29,11 @@ public sealed interface PlayerUpdateReason extends UpdateReason {
      */
     record Click(Player player, xyz.xenondevs.invui.Click click) implements PlayerUpdateReason {
 
+        /**
+         * Creates a new {@link Click} update reason from a {@link xyz.xenondevs.invui.Click}.
+         *
+         * @param click The click that was performed.
+         */
         public Click(xyz.xenondevs.invui.Click click) {
             this(click.player(), click);
         }
@@ -52,7 +57,7 @@ record Drag(
     /**
      * A {@link PlayerUpdateReason} for selecting an item in a bundle.
      *
-     * @param player The player that selected the item.
+     * @param player     The player that selected the item.
      * @param bundleSlot The slot inside the bundle that was selected.
      */
     record BundleSelect(Player player, int bundleSlot) implements PlayerUpdateReason {}

invui/src/main/java/xyz/xenondevs/invui/item/Item.java

@@ -53,6 +53,7 @@ public sealed interface Item permits AbstractItem, BoundItem {
      * Called when the {@link #getItemProvider(Player) ItemProvider} has bundle contents
      * and the player selects a bundle slot.
      *
+     * @param player The {@link Player} that interacted with the bundle.
      * @param bundleSlot The selected bundle slot, or -1 if the player's cursor left the {@link ItemProvider}.
      */
     void handleBundleSelect(Player player, int bundleSlot);