From 7a32697906a1e0f36604c1e3b238d9e898122a92 Mon Sep 17 00:00:00 2001
From: Craftinators <craftinatorssx@gmail.com>
Date: Thu, 16 Mar 2023 17:55:53 -0400
Subject: [PATCH] docs(HookHMCCosmetics): documented class

---
 .../hmccosmetics/hooks/items/HookHMCCosmetics.java  | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/HookHMCCosmetics.java b/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/HookHMCCosmetics.java
index 193b12d1..425d7678 100644
--- a/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/HookHMCCosmetics.java
+++ b/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/HookHMCCosmetics.java
@@ -3,18 +3,23 @@ package com.hibiscusmc.hmccosmetics.hooks.items;
 import com.hibiscusmc.hmccosmetics.cosmetic.Cosmetic;
 import com.hibiscusmc.hmccosmetics.cosmetic.Cosmetics;
 import com.hibiscusmc.hmccosmetics.hooks.Hook;
-import org.bukkit.event.Listener;
 import org.bukkit.inventory.ItemStack;
+import org.jetbrains.annotations.NotNull;
 
-public class HookHMCCosmetics extends Hook implements Listener {
-
+/**
+ * A hook that integrates the plugin {@link com.hibiscusmc.hmccosmetics.HMCCosmeticsPlugin HMCCosmetics} to provide cosmetic items
+ */
+public class HookHMCCosmetics extends Hook {
     public HookHMCCosmetics() {
         super("HMCCosmetics");
         setEnabledItemHook(true);
     }
 
+    /**
+     * Gets a cosmetic {@link ItemStack} that is associated with the provided id from the plugin {@link com.hibiscusmc.hmccosmetics.HMCCosmeticsPlugin HMCCosmetics}
+     */
     @Override
-    public ItemStack getItem(String itemId) {
+    public ItemStack getItem(@NotNull String itemId) {
         Cosmetic cosmetic = Cosmetics.getCosmetic(itemId);
         if (cosmetic == null) return null;
         return cosmetic.getItem();