Skip to content

Commit 5c885ab

Browse files
committed
Added javadocs
1 parent 8c136b4 commit 5c885ab

File tree

1 file changed

+8
-3
lines changed
  • src/main/java/org/spongepowered/api/item/recipe

1 file changed

+8
-3
lines changed

src/main/java/org/spongepowered/api/item/recipe/Recipe.java

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,18 @@
6060
*/
6161
public interface Recipe<T extends RecipeInput> {
6262

63+
/**
64+
* Provides the registered key for this recipe
65+
*
66+
* @return The key the recipe is registered with
67+
*/
6368
Optional<ResourceKey> key();
6469

6570
/**
6671
* Checks if the given inventory fits the required constraints to make a valid recipe
6772
*
6873
* @param inventory The inventory to check for validity
69-
* @param world The world this recipe would be used in
74+
* @param world The world this recipe would be used in
7075
*
7176
* @return True if the given input matches this recipe's requirements
7277
*/
@@ -103,7 +108,7 @@ public interface Recipe<T extends RecipeInput> {
103108
*
104109
* @param inventory The input inventory
105110
* @return The list of items to be added to the inventory of the player
106-
* when the recipe has been fulfilled (possibly empty)
111+
* when the recipe has been fulfilled (possibly empty)
107112
*/
108113
List<ItemStackSnapshot> remainingItems(T inventory);
109114

@@ -114,7 +119,7 @@ public interface Recipe<T extends RecipeInput> {
114119
* {@link #isValid(RecipeInput, ServerWorld)}.</p>
115120
*
116121
* @param inventory The input inventory
117-
* @param world The world this recipe would be used in
122+
* @param world The world this recipe would be used in
118123
*
119124
* @return A {@link RecipeResult} if the arguments satisfy
120125
* {@link #isValid(RecipeInput, ServerWorld)}, or

0 commit comments

Comments
 (0)