Add missing javadoc

Author: NichtStudioCode

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

@@ -137,9 +137,15 @@ public static void addGlobalIngredientElementSupplier(char key, Supplier<? exten
         addGlobalIngredient(key, SlotElementSupplier.fromSupplier(elementSupplier));
     }
 
+    /**
+     * Adds a global {@link SlotElementSupplier} ingredient under the given key.
+     *
+     * @param key             The key of the ingredient
+     * @param elementSupplier The {@link SlotElementSupplier} ingredient
+     */
     public static void addGlobalIngredient(char key, SlotElementSupplier elementSupplier) {
         if (globalIngredientsFrozen)
-            throw new IllegalStateException("Global ingredients are frozen");         
+            throw new IllegalStateException("Global ingredients are frozen");
         globalIngredientMap.put(key, new Ingredient.Element(elementSupplier));
     }
 

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

@@ -13,12 +13,12 @@
 import xyz.xenondevs.invui.gui.Gui;
 import xyz.xenondevs.invui.internal.util.ArrayUtils;
 import xyz.xenondevs.invui.internal.util.CollectionUtils;
+import xyz.xenondevs.invui.util.ObserverAtSlot;
 import xyz.xenondevs.invui.inventory.event.InventoryClickEvent;
 import xyz.xenondevs.invui.inventory.event.ItemPostUpdateEvent;
 import xyz.xenondevs.invui.inventory.event.ItemPreUpdateEvent;
 import xyz.xenondevs.invui.inventory.event.UpdateReason;
 import xyz.xenondevs.invui.util.ItemUtils;
-import xyz.xenondevs.invui.util.ObserverAtSlot;
 import xyz.xenondevs.invui.window.Window;
 
 import java.util.*;
@@ -1419,6 +1419,8 @@ private int takeFrom(@Nullable UpdateReason updateReason, int slot, int maxTake)
     }
 
     /**
+     * Returns this inventory as a Bukkit inventory.
+     *
      * @return This inventory as a Bukkit inventory.
      */
     @ApiStatus.Experimental

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

@@ -19,6 +19,7 @@
 import java.util.function.Function;
 
 // TODO: equals+hashCode for normal referencing inventories
+
 /**
  * A {@link xyz.xenondevs.invui.inventory.Inventory} which is backed by a bukkit {@link Inventory}.
  * <p>
@@ -190,6 +191,11 @@ public int getUpdatePeriod(int what) {
      */
     public static final class PlayerStorageContents extends ReferencingInventory {
 
+        /**
+         * Constructs a new {@link PlayerStorageContents}.
+         *
+         * @param inventory The {@link PlayerInventory} to reference.
+         */
         public PlayerStorageContents(PlayerInventory inventory) {
             super(inventory, Inventory::getStorageContents, Inventory::getItem, Inventory::setItem);
         }
@@ -247,7 +253,7 @@ public int hashCode() {
         @Override
         public boolean equals(Object obj) {
             return obj instanceof ReferencingInventory.PlayerStorageContents other &&
-                getReferencedInventory().equals(other.getReferencedInventory());
+                   getReferencedInventory().equals(other.getReferencedInventory());
         }
     }
 

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

@@ -21,6 +21,7 @@ public class InventoryClickEvent extends ClickEvent {
      * @param inventory The {@link Inventory} that was clicked.
      * @param slot      The slot that was clicked.
      * @param click     The {@link Click} that was performed.
+     * @param action    The {@link InventoryAction} of this event, representing the normal outcome of the click.
      */
     public InventoryClickEvent(Inventory inventory, int slot, Click click, InventoryAction action) {
         super(click);

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

@@ -11,6 +11,9 @@
  */
 public abstract class AbstractItem implements Item {
 
+    /**
+     * The observers of this item.
+     */
     protected final Set<ObserverAtSlot> observers = ConcurrentHashMap.newKeySet();
 
     @Override

invui/src/main/java/xyz/xenondevs/invui/window/MerchantWindow.java

@@ -91,10 +91,26 @@ static Builder builder() {
     @UnmodifiableView
     List<Trade> getTrades();
 
+    /**
+     * Adds a handler that is called when the selected trade is changed.
+     * Receives the old and new selected trade indices.
+     *
+     * @param handler The handler
+     */
     void addTradeSelectHandler(BiConsumer<? super Integer, ? super Integer> handler);
 
+    /**
+     * Removes a handler that is called when the selected trade is changed.
+     *
+     * @param handler The handler
+     */
     void removeTradeSelectHandler(BiConsumer<? super Integer, ? super Integer> handler);
 
+    /**
+     * Sets the handlers that are called when the selected trade is changed.
+     *
+     * @param handlers The handlers
+     */
     void setTradeSelectHandlers(List<? extends BiConsumer<Integer, Integer>> handlers);
 
     @UnmodifiableView
@@ -381,8 +397,21 @@ default Builder setTrades(List<? extends Trade> trades) {
          */
         Builder setTrades(MutableProperty<List<? extends Trade>> trades);
 
+        /**
+         * Adds a handler that is called when the selected trade is changed.
+         * Receives the old and new selected trade indices.
+         *
+         * @param handler The handler
+         * @return This {@link Builder}
+         */
         Builder addTradeSelectHandler(BiConsumer<? super Integer, ? super Integer> handler);
 
+        /**
+         * Sets the handlers that are called when the selected trade is changed.
+         *
+         * @param handlers The handlers
+         * @return This {@link Builder}
+         */
         Builder setTradeSelectHandlers(List<? extends BiConsumer<Integer, Integer>> handlers);
 
     }