From 1d51ee07118abbe175661768c099097418380659 Mon Sep 17 00:00:00 2001
From: Craftinators <craftinatorssx@gmail.com>
Date: Fri, 17 Mar 2023 08:37:52 -0400
Subject: [PATCH] docs(HookMythic): documented class

---
 .../hmccosmetics/hooks/items/HookMythic.java       | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/HookMythic.java b/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/HookMythic.java
index 7b1972bd..58679bcf 100644
--- a/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/HookMythic.java
+++ b/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/HookMythic.java
@@ -2,17 +2,25 @@ package com.hibiscusmc.hmccosmetics.hooks.items;
 
 import com.hibiscusmc.hmccosmetics.hooks.Hook;
 import io.lumine.mythic.bukkit.MythicBukkit;
-import org.bukkit.event.Listener;
 import org.bukkit.inventory.ItemStack;
+import org.jetbrains.annotations.NotNull;
 
-public class HookMythic extends Hook implements Listener {
+/**
+ * A hook that integrates the plugin {@link io.lumine.mythic.bukkit.MythicBukkit MythicBukkit} to provide cosmetic items
+ */
+@SuppressWarnings("SpellCheckingInspection")
+public class HookMythic extends Hook {
     public HookMythic() {
         super("mythicmobs");
         setEnabledItemHook(true);
     }
 
+
+    /**
+     * Gets a cosmetic {@link ItemStack} that is associated with the provided id from the plugin {@link io.lumine.mythic.bukkit.MythicBukkit MythicBukkit}
+     */
     @Override
-    public ItemStack getItem(String itemId) {
+    public ItemStack getItem(@NotNull String itemId) {
         return MythicBukkit.inst().getItemManager().getItemStack(itemId);
     }
 }