From 85c80ea653ec84a892f77d1e80d5bc9a42f4c1e3 Mon Sep 17 00:00:00 2001 From: shedaniel Date: Sun, 25 Dec 2022 19:00:07 +0800 Subject: Add @since to javadocs to indicate REI 8.4 --- .../shedaniel/rei/api/client/registry/display/DisplayRegistry.java | 7 +++++++ .../java/me/shedaniel/rei/api/common/entry/EntryIngredient.java | 3 +++ .../main/java/me/shedaniel/rei/api/common/entry/EntryStack.java | 3 +++ .../rei/api/common/entry/settings/EntryIngredientSetting.java | 7 +++++++ 4 files changed, 20 insertions(+) diff --git a/api/src/main/java/me/shedaniel/rei/api/client/registry/display/DisplayRegistry.java b/api/src/main/java/me/shedaniel/rei/api/client/registry/display/DisplayRegistry.java index b708a2e31..1a93920c6 100644 --- a/api/src/main/java/me/shedaniel/rei/api/client/registry/display/DisplayRegistry.java +++ b/api/src/main/java/me/shedaniel/rei/api/client/registry/display/DisplayRegistry.java @@ -233,6 +233,7 @@ public interface DisplayRegistry extends RecipeManagerContext { * @param filler the filler, taking a {@code T} and returning a {@code D} * @param the type of object * @param the type of display + * @since 8.4 */ @ApiStatus.Experimental default , D extends Display> void registerRecipesFiller(Class typeClass, RecipeType recipeType, Function> filler) { @@ -264,6 +265,7 @@ public interface DisplayRegistry extends RecipeManagerContext { * @param filler the filler, taking a {@code T} and returning a {@code D} * @param the type of object * @param the type of display + * @since 8.4 */ @ApiStatus.Experimental default , D extends Display> void registerRecipesFiller(Class typeClass, Predicate> recipeType, Function> filler) { @@ -295,6 +297,7 @@ public interface DisplayRegistry extends RecipeManagerContext { * @param filler the filler, taking a {@code T} and returning a {@code D} * @param the type of object * @param the type of display + * @since 8.4 */ @ApiStatus.Experimental default , D extends Display> void registerRecipesFiller(Class typeClass, Predicate> recipeType, Predicate predicate, Function> filler) { @@ -326,6 +329,7 @@ public interface DisplayRegistry extends RecipeManagerContext { * @param filler the filler, taking a {@code T} and returning a {@code D} * @param the type of object * @param the type of display + * @since 8.4 */ @ApiStatus.Experimental default void registerDisplaysFiller(Class typeClass, Function> filler) { @@ -357,6 +361,7 @@ public interface DisplayRegistry extends RecipeManagerContext { * @param filler the filler, taking a {@code T} and returning a {@code D} * @param the type of object * @param the type of display + * @since 8.4 */ @ApiStatus.Experimental void registerDisplaysFiller(Class typeClass, Predicate predicate, Function> filler); @@ -387,6 +392,7 @@ public interface DisplayRegistry extends RecipeManagerContext { * @param filler the filler, taking a {@code T} and returning a {@code D} * @param the type of object * @param the type of display + * @since 8.4 */ @ApiStatus.Experimental void registerDisplaysFiller(Class typeClass, BiPredicate predicate, Function> filler); @@ -412,6 +418,7 @@ public interface DisplayRegistry extends RecipeManagerContext { * @param predicate the predicate of the object * @param filler the filler, taking an object and returning a {@code D} * @param the type of display + * @since 8.4 */ @ApiStatus.Experimental void registerDisplaysFiller(Predicate predicate, Function> filler); diff --git a/api/src/main/java/me/shedaniel/rei/api/common/entry/EntryIngredient.java b/api/src/main/java/me/shedaniel/rei/api/common/entry/EntryIngredient.java index f21719676..b44eb7bb1 100644 --- a/api/src/main/java/me/shedaniel/rei/api/common/entry/EntryIngredient.java +++ b/api/src/main/java/me/shedaniel/rei/api/common/entry/EntryIngredient.java @@ -209,6 +209,7 @@ public interface EntryIngredient extends List> { * @param setting the setting to get * @param the type of the setting * @return the value of the setting + * @since 8.4 */ @Nullable @ApiStatus.Experimental @@ -224,6 +225,7 @@ public interface EntryIngredient extends List> { * @param value the value of the setting to apply * @param the type of the setting * @return this {@link EntryStack} + * @since 8.4 */ @ApiStatus.Experimental EntryIngredient setting(EntryIngredientSetting setting, T value); @@ -240,6 +242,7 @@ public interface EntryIngredient extends List> { * For that reason, all ingredients passed to this method must have the same size. * * @param ingredients the ingredients to unify + * @since 8.4 */ @ApiStatus.Experimental static void unifyFocuses(EntryIngredient... ingredients) { diff --git a/api/src/main/java/me/shedaniel/rei/api/common/entry/EntryStack.java b/api/src/main/java/me/shedaniel/rei/api/common/entry/EntryStack.java index 4b79fce3f..878e083ba 100644 --- a/api/src/main/java/me/shedaniel/rei/api/common/entry/EntryStack.java +++ b/api/src/main/java/me/shedaniel/rei/api/common/entry/EntryStack.java @@ -516,6 +516,7 @@ public interface EntryStack extends TextRepresentable, Renderer { * @param tooltipProcessor the processor to modify the tooltips * @return this {@link EntryStack} * @see EntryStack#getTooltip(TooltipContext, boolean) for how the tooltip is resolved + * @since 8.4 */ @SuppressWarnings("rawtypes") @Environment(EnvType.CLIENT) @@ -533,6 +534,7 @@ public interface EntryStack extends TextRepresentable, Renderer { * @return this {@link EntryStack} * @see EntryStack#getRenderer() for how the tooltip is resolved * @see EntryRenderer#empty() for an empty renderer + * @since 8.4 */ @Environment(EnvType.CLIENT) default EntryStack withRenderer(EntryRenderer renderer) { @@ -548,6 +550,7 @@ public interface EntryStack extends TextRepresentable, Renderer { * @param renderer the new renderer to use * @return this {@link EntryStack} * @see EntryStack#getRenderer() for how the tooltip is resolved + * @since 8.4 */ @SuppressWarnings("rawtypes") @Environment(EnvType.CLIENT) diff --git a/api/src/main/java/me/shedaniel/rei/api/common/entry/settings/EntryIngredientSetting.java b/api/src/main/java/me/shedaniel/rei/api/common/entry/settings/EntryIngredientSetting.java index 88766ff5d..78f61f446 100644 --- a/api/src/main/java/me/shedaniel/rei/api/common/entry/settings/EntryIngredientSetting.java +++ b/api/src/main/java/me/shedaniel/rei/api/common/entry/settings/EntryIngredientSetting.java @@ -23,10 +23,17 @@ package me.shedaniel.rei.api.common.entry.settings; +import me.shedaniel.rei.api.common.entry.EntryIngredient; import org.jetbrains.annotations.ApiStatus; import java.util.UUID; +/** + * Represents a setting for an {@link EntryIngredient}. + * + * @param the type of the setting + * @since 8.4 + */ @ApiStatus.Experimental public interface EntryIngredientSetting { EntryIngredientSetting FOCUS_UUID = new EntryIngredientSetting<>() {}; -- cgit