From a030d1272b65c37ad8cbe2ef3bafc752af27f773 Mon Sep 17 00:00:00 2001
From: Craftinators <craftinatorssx@gmail.com>
Date: Fri, 17 Mar 2023 08:44:10 -0400
Subject: [PATCH] docs(HookOraxen): documented class

---
 .../hmccosmetics/hooks/items/HookOraxen.java       | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/HookOraxen.java b/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/HookOraxen.java
index 3a808e42..50a7c167 100644
--- a/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/HookOraxen.java
+++ b/common/src/main/java/com/hibiscusmc/hmccosmetics/hooks/items/HookOraxen.java
@@ -3,18 +3,24 @@ package com.hibiscusmc.hmccosmetics.hooks.items;
 import com.hibiscusmc.hmccosmetics.hooks.Hook;
 import io.th0rgal.oraxen.api.OraxenItems;
 import io.th0rgal.oraxen.items.ItemBuilder;
-import org.bukkit.event.Listener;
 import org.bukkit.inventory.ItemStack;
+import org.jetbrains.annotations.NotNull;
 
-public class HookOraxen extends Hook implements Listener {
-
+/**
+ * A hook that integrates the plugin {@link io.th0rgal.oraxen.OraxenPlugin OraxenPlugin} to provide cosmetic items
+ */
+@SuppressWarnings("SpellCheckingInspection")
+public class HookOraxen extends Hook {
     public HookOraxen() {
         super("oraxen");
         setEnabledItemHook(true);
     }
 
+    /**
+     * Gets a cosmetic {@link ItemStack} that is associated with the provided id from the plugin {@link io.th0rgal.oraxen.OraxenPlugin OraxenPlugin}
+     */
     @Override
-    public ItemStack getItem(String itemId) {
+    public ItemStack getItem(@NotNull String itemId) {
         ItemBuilder builder = OraxenItems.getItemById(itemId);
         if (builder == null) return null;
         return builder.build();