Fix doc

7 files changed, 17 insertions, 19 deletions

diff --git a/src/main/java/me/shedaniel/rei/api/ClientHelper.java b/src/main/java/me/shedaniel/rei/api/ClientHelper.java
index e0fbfbed3..fe33ddc64 100644
--- a/src/main/java/me/shedaniel/rei/api/ClientHelper.java
+++ b/src/main/java/me/shedaniel/rei/api/ClientHelper.java
@@ -81,22 +81,20 @@ public interface ClientHelper {
     /**
      * Gets the mod from an item
      *
-     * @param item
+     * @param item the item to find
      * @return the mod name
      */
     String getModFromItem(Item item);
     
     /**
      * Tries to delete the player's cursor item
-     *
-     * @return whether it failed
      */
     void sendDeletePacket();
     
     /**
      * Gets the formatted mod from an item
      *
-     * @param item
+     * @param item the item to find
      * @return the mod name with blue and italic formatting
      */
     String getFormattedModFromItem(Item item);
@@ -104,7 +102,7 @@ public interface ClientHelper {
     /**
      * Gets the formatted mod from an identifier
      *
-     * @param identifier
+     * @param identifier the identifier to find
      * @return the mod name with blue and italic formatting
      */
     String getFormattedModFromIdentifier(Identifier identifier);
@@ -112,7 +110,7 @@ public interface ClientHelper {
     /**
      * Gets the mod from an identifier
      *
-     * @param identifier
+     * @param identifier the identifier to find
      * @return the mod name
      */
     String getModFromIdentifier(Identifier identifier);
diff --git a/src/main/java/me/shedaniel/rei/api/ConfigManager.java b/src/main/java/me/shedaniel/rei/api/ConfigManager.java
index 00ebd2e46..4b138b639 100644
--- a/src/main/java/me/shedaniel/rei/api/ConfigManager.java
+++ b/src/main/java/me/shedaniel/rei/api/ConfigManager.java
@@ -15,14 +15,14 @@ public interface ConfigManager {
     /**
      * Saves the config.
      *
-     * @throws IOException
+     * @throws IOException when error
      */
     void saveConfig() throws IOException;
     
     /**
      * Loads the config from the json file, creates the file if not found.
      *
-     * @throws IOException
+     * @throws IOException when error
      */
     void loadConfig() throws IOException;
     
diff --git a/src/main/java/me/shedaniel/rei/api/DisplayHelper.java b/src/main/java/me/shedaniel/rei/api/DisplayHelper.java
index 51e54302c..9fea85839 100644
--- a/src/main/java/me/shedaniel/rei/api/DisplayHelper.java
+++ b/src/main/java/me/shedaniel/rei/api/DisplayHelper.java
@@ -63,7 +63,7 @@ public interface DisplayHelper {
         /**
          * Gets the base supported class for the bounds handler
          *
-         * @return
+         * @return the base class
          */
         Class getBaseSupportedClass();
         
diff --git a/src/main/java/me/shedaniel/rei/api/DisplayVisibilityHandler.java b/src/main/java/me/shedaniel/rei/api/DisplayVisibilityHandler.java
index 39a106783..8f6156891 100644
--- a/src/main/java/me/shedaniel/rei/api/DisplayVisibilityHandler.java
+++ b/src/main/java/me/shedaniel/rei/api/DisplayVisibilityHandler.java
@@ -18,10 +18,10 @@ public interface DisplayVisibilityHandler {
     
     /**
      * Handles the visibility of the display.
-     * {@link DisplayVisibility.PASS} to pass the handling to another handler
-     * {@link DisplayVisibility.ALWAYS_VISIBLE} to always display it
-     * {@link DisplayVisibility.CONFIG_OPTIONAL} to allow user to configure the visibility
-     * {@link DisplayVisibility.NEVER_VISIBLE} to never display it
+     * {@link DisplayVisibility#PASS} to pass the handling to another handler
+     * {@link DisplayVisibility#ALWAYS_VISIBLE} to always display it
+     * {@link DisplayVisibility#CONFIG_OPTIONAL} to allow user to configure the visibility
+     * {@link DisplayVisibility#NEVER_VISIBLE} to never display it
      *
      * @param category the category of the display
      * @param display  the display of the recipe
diff --git a/src/main/java/me/shedaniel/rei/api/ItemRegistry.java b/src/main/java/me/shedaniel/rei/api/ItemRegistry.java
index 8751da416..0a9da2c46 100644
--- a/src/main/java/me/shedaniel/rei/api/ItemRegistry.java
+++ b/src/main/java/me/shedaniel/rei/api/ItemRegistry.java
@@ -32,7 +32,7 @@ public interface ItemRegistry {
     /**
      * Registers an new stack to the item list
      *
-     * @param afterItem
+     * @param afterItem the stack to put after
      * @param stack     the stack to register
      */
     void registerItemStack(Item afterItem, ItemStack stack);
diff --git a/src/main/java/me/shedaniel/rei/api/REIPluginEntry.java b/src/main/java/me/shedaniel/rei/api/REIPluginEntry.java
index 615c53fd9..87876b46e 100644
--- a/src/main/java/me/shedaniel/rei/api/REIPluginEntry.java
+++ b/src/main/java/me/shedaniel/rei/api/REIPluginEntry.java
@@ -43,7 +43,7 @@ public interface REIPluginEntry {
     /**
      * Not called anymore!
      *
-     * @param recipeHelper
+     * @param recipeHelper the helper class
      * @see REIPluginEntry#registerOthers(RecipeHelper)
      */
     @Deprecated
diff --git a/src/main/java/me/shedaniel/rei/api/RecipeCategory.java b/src/main/java/me/shedaniel/rei/api/RecipeCategory.java
index 6993b45c4..27a68eafd 100644
--- a/src/main/java/me/shedaniel/rei/api/RecipeCategory.java
+++ b/src/main/java/me/shedaniel/rei/api/RecipeCategory.java
@@ -117,9 +117,9 @@ public interface RecipeCategory<T extends RecipeDisplay> {
     
     /**
      * Gets the recipe display height
+     * Please do not override this, use {@link RecipeCategory#getDisplaySettings()} instead
      *
      * @return the recipe display height
-     * @apiNote Please do not override this, use {@link RecipeCategory#getDisplaySettings()} instead
      */
     default int getDisplayHeight() {
         return RecipeHelper.getInstance().getCachedCategorySettings(getIdentifier()).map(settings -> settings.getDisplayHeight(this)).orElse(0);
@@ -127,20 +127,20 @@ public interface RecipeCategory<T extends RecipeDisplay> {
     
     /**
      * Gets the recipe display width
+     * Please do not override this, use {@link RecipeCategory#getDisplaySettings()} instead
      *
      * @param display the recipe display
      * @return the recipe display width
-     * @apiNote Please do not override this, use {@link RecipeCategory#getDisplaySettings()} instead
      */
     default int getDisplayWidth(T display) {
         return RecipeHelper.getInstance().getCachedCategorySettings(getIdentifier()).map(settings -> settings.getDisplayWidth(this, display)).orElse(0);
     }
     
     /**
-     * Gets the maximum recipe per page
+     * Gets the maximum recipe per page.
+     * Please do not override this, use {@link RecipeCategory#getDisplaySettings()} instead
      *
      * @return the maximum amount of recipes for page
-     * @apiNote Please do not override this, use {@link RecipeCategory#getDisplaySettings()} instead
      */
     default int getMaximumRecipePerPage() {
         return RecipeHelper.getInstance().getCachedCategorySettings(getIdentifier()).map(settings -> settings.getMaximumRecipePerPage(this)).orElse(0);