From 357388d49c306a288f2c56cb6f25589237f7284e Mon Sep 17 00:00:00 2001
From: Unknown <shekwancheung0528@gmail.com>
Date: Sun, 12 May 2019 01:32:04 +0800
Subject: Small documentations

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

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

diff --git a/src/main/java/me/shedaniel/rei/api/DisplaySettings.java b/src/main/java/me/shedaniel/rei/api/DisplaySettings.java
index 334d6cc6f..ad9468bd2 100644
--- a/src/main/java/me/shedaniel/rei/api/DisplaySettings.java
+++ b/src/main/java/me/shedaniel/rei/api/DisplaySettings.java
@@ -2,12 +2,34 @@ package me.shedaniel.rei.api;
 
 public interface DisplaySettings<T extends RecipeDisplay> {
     
+    /**
+     * Gets the recipe display height
+     *
+     * @param category the category of the display
+     * @return the height
+     */
     int getDisplayHeight(RecipeCategory category);
     
+    /**
+     * Gets the recipe display width
+     *
+     * @param category the category of the display
+     * @param display  the display of the recipe
+     * @return the width
+     */
     int getDisplayWidth(RecipeCategory category, T display);
     
+    /**
+     * Gets the maximum amount of recipe displays of the category displayed at the same time.
+     * @param category the category of the displays
+     * @return the maximum amount
+     */
     int getMaximumRecipePerPage(RecipeCategory category);
     
+    /**
+     * Gets the fixed amount of recipes per page.
+     * @return the amount of recipes, returns -1 if not fixed
+     */
     default int getFixedRecipesPerPage() {
         return -1;
     }
-- 
cgit