From 5b129cc254132a01488e69ea4fda6aff4b673cb5 Mon Sep 17 00:00:00 2001
From: Craftinators <craftinatorssx@gmail.com>
Date: Thu, 16 Mar 2023 18:40:50 -0400
Subject: [PATCH] docs(HookItemAdder): documented class

---
 .../hmccosmetics/hooks/items/HookItemAdder.java | 17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)

diff --git a/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/HookItemAdder.java b/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/HookItemAdder.java
index 441d9c2d..c7b1a7ac 100644
--- a/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/HookItemAdder.java
+++ b/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/HookItemAdder.java
@@ -7,11 +7,14 @@ import dev.lone.itemsadder.api.CustomStack;
 import dev.lone.itemsadder.api.Events.ItemsAdderLoadDataEvent;
 import org.bukkit.Material;
 import org.bukkit.event.EventHandler;
-import org.bukkit.event.Listener;
 import org.bukkit.inventory.ItemStack;
+import org.jetbrains.annotations.NotNull;
 
-public class HookItemAdder extends Hook implements Listener {
-
+/**
+ * A hook that integrates the plugin {@link dev.lone.itemsadder.api.ItemsAdder ItemsAdder} to provide items
+ */
+@SuppressWarnings("SpellCheckingInspection")
+public class HookItemAdder extends Hook {
     private boolean enabled = false;
 
     public HookItemAdder() {
@@ -19,8 +22,11 @@ public class HookItemAdder extends Hook implements Listener {
         setEnabledItemHook(true);
     }
 
+    /**
+     * Gets a cosmetic {@link ItemStack} that is associated with the provided id from the plugin {@link dev.lone.itemsadder.api.ItemsAdder ItemsAdder}
+     */
     @Override
-    public ItemStack getItem(String itemId) {
+    public ItemStack getItem(@NotNull String itemId) {
         if (enabled) {
             CustomStack stack = CustomStack.getInstance(itemId);
             if (stack == null) return null;
@@ -32,7 +38,8 @@ public class HookItemAdder extends Hook implements Listener {
 
     @EventHandler
     public void onItemAdderDataLoad(ItemsAdderLoadDataEvent event) {
-        if (enabled && !Settings.getItemsAdderReloadChange()) return; // Defaultly it will only run once at startup. If hook setting is enable
+        // By default, it will only run once at startup, if hook setting is enabled
+        if (enabled && !Settings.getItemsAdderReloadChange()) return;
         this.enabled = true;
         HMCCosmeticsPlugin.setup();
     }