From eab120d5619f972e29afc9776959f6d6096d3926 Mon Sep 17 00:00:00 2001
From: Unknown <shekwancheung0528@gmail.com>
Date: Sun, 12 May 2019 10:36:42 +0800
Subject: More docs

---
 .../java/me/shedaniel/rei/api/RecipeHelper.java    | 23 ++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'src/main/java/me/shedaniel/rei/api/RecipeHelper.java')

diff --git a/src/main/java/me/shedaniel/rei/api/RecipeHelper.java b/src/main/java/me/shedaniel/rei/api/RecipeHelper.java
index e5e89cdd0..58d67e97a 100644
--- a/src/main/java/me/shedaniel/rei/api/RecipeHelper.java
+++ b/src/main/java/me/shedaniel/rei/api/RecipeHelper.java
@@ -17,6 +17,9 @@ import java.util.Optional;
 
 public interface RecipeHelper {
     
+    /**
+     * @return the api instance of {@link me.shedaniel.rei.client.RecipeHelperImpl}
+     */
     static RecipeHelper getInstance() {
         return RoughlyEnoughItemsCore.getRecipeHelper();
     }
@@ -27,14 +30,34 @@ public interface RecipeHelper {
     
     List<ItemStack> findCraftableByItems(List<ItemStack> inventoryItems);
     
+    /**
+     * Registers a category
+     *
+     * @param category the category to register
+     */
     void registerCategory(RecipeCategory category);
     
+    /**
+     * Registers a recipe display
+     *
+     * @param categoryIdentifier the category to display in
+     * @param display            the recipe display
+     */
     void registerDisplay(Identifier categoryIdentifier, RecipeDisplay display);
     
     Map<RecipeCategory, List<RecipeDisplay>> getRecipesFor(ItemStack stack);
     
+    /**
+     * Gets the vanilla recipe manager
+     *
+     * @return the recipe manager
+     */
     RecipeManager getRecipeManager();
     
+    /**
+     * Gets all registered categories
+     * @return the list of categories
+     */
     List<RecipeCategory> getAllCategories();
     
     Map<RecipeCategory, List<RecipeDisplay>> getUsagesFor(ItemStack stack);
-- 
cgit