Document the getCodec method

apple502j · Sep 27, 2023 · 0190598 · 0190598
1 parent 3ccb77f
commit 0190598
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/...rc/main/java/net/fabricmc/fabric/api/recipe/v1/ingredient/CustomIngredientSerializer.java b/...rc/main/java/net/fabricmc/fabric/api/recipe/v1/ingredient/CustomIngredientSerializer.java
@@ -20,6 +20,7 @@
 import org.jetbrains.annotations.Nullable;
 
 import net.minecraft.network.PacketByteBuf;
+import net.minecraft.recipe.Ingredient;
 import net.minecraft.util.Identifier;
 
 import net.fabricmc.fabric.impl.recipe.ingredient.CustomIngredientImpl;
@@ -54,6 +55,15 @@ static CustomIngredientSerializer<?> get(Identifier identifier) {
 	 */
 	Identifier getIdentifier();
 
+	/**
+	 * {@return the codec}.
+	 *
+	 * <p>Codecs are used to read the ingredient from the recipe JSON files.
+	 * If the custom ingredient
+	 *
+	 * @see Ingredient#ALLOW_EMPTY_CODEC
+	 * @see Ingredient#DISALLOW_EMPTY_CODEC
+	 */
 	Codec<T> getCodec(boolean allowEmpty);
 
 	/**