From 93c6a42124d58fd3dd642b91aa6b5879e52e5955 Mon Sep 17 00:00:00 2001
From: Pyrbu <pyrmcserver@gmail.com>
Date: Tue, 31 Oct 2023 20:25:59 +0100
Subject: [PATCH] fix all of the javadoc warnings

---
 api/src/main/java/lol/pyr/znpcsplus/api/NpcApiProvider.java    | 3 +++
 api/src/main/java/lol/pyr/znpcsplus/api/npc/NpcRegistry.java   | 2 +-
 .../main/java/lol/pyr/znpcsplus/api/npc/NpcTypeRegistry.java   | 2 ++
 3 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/api/src/main/java/lol/pyr/znpcsplus/api/NpcApiProvider.java b/api/src/main/java/lol/pyr/znpcsplus/api/NpcApiProvider.java
index 16dd426..b35235c 100644
--- a/api/src/main/java/lol/pyr/znpcsplus/api/NpcApiProvider.java
+++ b/api/src/main/java/lol/pyr/znpcsplus/api/NpcApiProvider.java
@@ -30,6 +30,9 @@ public class NpcApiProvider {
     /**
      * Internal method used to register the main instance of the plugin as the api provider
      * You probably shouldn't call this method under any circumstances
+     *
+     * @param plugin Instance of the ZNPCsPlus plugin
+     * @param api Instance of the ZNPCsPlus api
      */
     public static void register(Plugin plugin, NpcApi api) {
         NpcApiProvider.api = api;
diff --git a/api/src/main/java/lol/pyr/znpcsplus/api/npc/NpcRegistry.java b/api/src/main/java/lol/pyr/znpcsplus/api/npc/NpcRegistry.java
index 51d8c19..4722e0b 100644
--- a/api/src/main/java/lol/pyr/znpcsplus/api/npc/NpcRegistry.java
+++ b/api/src/main/java/lol/pyr/znpcsplus/api/npc/NpcRegistry.java
@@ -41,7 +41,7 @@ public interface NpcRegistry {
      * @param world The {@link World} of the NPC entry
      * @param type The {@link NpcType} of the NPC entry
      * @param location The {@link NpcLocation} of the NPC entry
-     * @return
+     * @return The entry of the newly created npc
      */
     NpcEntry create(String id, World world, NpcType type, NpcLocation location);
 
diff --git a/api/src/main/java/lol/pyr/znpcsplus/api/npc/NpcTypeRegistry.java b/api/src/main/java/lol/pyr/znpcsplus/api/npc/NpcTypeRegistry.java
index 63c64cb..b0720db 100644
--- a/api/src/main/java/lol/pyr/znpcsplus/api/npc/NpcTypeRegistry.java
+++ b/api/src/main/java/lol/pyr/znpcsplus/api/npc/NpcTypeRegistry.java
@@ -9,11 +9,13 @@ public interface NpcTypeRegistry {
     /**
      * Gets a NPC type by name.
      * @param name The name of the NPC type.
+     * @return The type that is represented by the name or null if it doesnt exist
      */
     NpcType getByName(String name);
 
     /**
      * Gets all NPC types.
+     * @return all of the npc types
      */
     Collection<NpcType> getAll();
 }