From 357388d49c306a288f2c56cb6f25589237f7284e Mon Sep 17 00:00:00 2001 From: Unknown Date: Sun, 12 May 2019 01:32:04 +0800 Subject: Small documentations --- .../me/shedaniel/rei/api/DisplayVisibilityHandler.java | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'src/main/java/me/shedaniel/rei/api/DisplayVisibilityHandler.java') 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); } -- cgit