Small documentations

1 files changed, 16 insertions, 0 deletions

diff --git a/src/main/java/me/shedaniel/rei/api/DisplayVisibilityHandler.java b/src/main/java/me/shedaniel/rei/api/DisplayVisibilityHandler.java
index 813cfaad6..435d91d49 100644
--- a/src/main/java/me/shedaniel/rei/api/DisplayVisibilityHandler.java
+++ b/src/main/java/me/shedaniel/rei/api/DisplayVisibilityHandler.java
@@ -2,10 +2,26 @@ package me.shedaniel.rei.api;
 
 public interface DisplayVisibilityHandler {
     
+    /**
+     * Gets the priority of the handler
+     *
+     * @return the priority
+     */
     default float getPriority() {
         return 0f;
     }
     
+    /**
+     * 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
+     *
+     * @param category the category of the display
+     * @param display  the display of the recipe
+     * @return the visibility
+     */
     DisplayVisibility handleDisplay(RecipeCategory category, RecipeDisplay display);
     
 }