Skip to content

Commit

Permalink
Fix javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
apple502j committed Aug 24, 2024
1 parent 49177ec commit fb90e29
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ private ConventionalItemTags() {
public static final TagKey<Item> GLAZED_TERRACOTTAS = register("glazed_terracottas");
public static final TagKey<Item> CONCRETES = register("concretes");
/**
* Block tag equivalent is {@link BlockTags#CONCRETE_POWDERS}.
* Block tag equivalent is {@link BlockTags#CONCRETE_POWDER}.
*/
public static final TagKey<Item> CONCRETE_POWDERS = register("concrete_powders");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,8 @@ interface Context {

/**
* The baker being used to bake this model.
* It can be used to {@linkplain Baker#getOrLoadModel load unbaked models} and
* {@linkplain Baker#bake load baked models}.
* It can be used to {@linkplain Baker#getModel get unbaked models} and
* {@linkplain Baker#bake bake models}.
*/
Baker baker();
}
Expand Down Expand Up @@ -227,8 +227,8 @@ interface Context {

/**
* The baker being used to bake this model.
* It can be used to {@linkplain Baker#getOrLoadModel load unbaked models} and
* {@linkplain Baker#bake load baked models}.
* It can be used to {@linkplain Baker#getModel get unbaked models} and
* {@linkplain Baker#bake bake models}.
*/
Baker baker();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public final class EntityTrackingEvents {
/**
* An event that is called before player starts tracking an entity.
* Typically, this occurs when an entity enters a client's view distance.
* This event is called before the player's client is sent the entity's {@link Entity#createSpawnPacket() spawn packet}.
* This event is called before the player's client is sent the entity's {@linkplain Entity#createSpawnPacket spawn packet}.
*/
public static final Event<StartTracking> START_TRACKING = EventFactory.createArrayBacked(StartTracking.class, callbacks -> (trackedEntity, player) -> {
for (StartTracking callback : callbacks) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ public interface CustomIngredient {
* <li>These stacks are generally used for display purposes, and need not be exhaustive or perfectly accurate.</li>
* <li>An exception is ingredients that {@linkplain #requiresTesting() don't require testing},
* for which it is important that the returned stacks correspond exactly to all the accepted {@link Item}s.</li>
* <li>At least one stack must be returned for the ingredient not to be considered {@linkplain Ingredient#isEmpty() empty}.</li>
* <li>The ingredient should try to return at least one stack with each accepted {@link Item}.
* This allows mods that inspect the ingredient to figure out which stacks it might accept.</li>
* </ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ static CustomIngredientSerializer<?> get(Identifier identifier) {
*
* <p>Codecs are used to read the ingredient from the recipe JSON files.
*
* @see Ingredient#ALLOW_EMPTY_CODEC
* @see Ingredient#CODEC
*/
MapCodec<T> getCodec();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ default CustomIngredient getCustomIngredient() {
*
* <p>If {@code false}, {@linkplain Ingredient#test testing this ingredient} with an item stack must be equivalent to checking whether
* the item stack's item is included in the ingredient's {@linkplain Ingredient#getMatchingStacks() list of matching stacks}.
* In that case, optimized matching logic can be used, for example using {@link Ingredient#getMatchingItemIds()}.
* In that case, optimized matching logic can be used.
*
* <p>If {@code true}, the ingredient must always be tested using {@link Ingredient#test(ItemStack)}.
* Note that Fabric patches some vanilla systems such as shapeless recipes to account for this.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public static long fromBucketFraction(long numerator, long denominator) {
public static final int LAVA_VISCOSITY = 6000;
public static final int LAVA_VISCOSITY_NETHER = 2000;
/**
* For flowable fluids, the viscosity should match {@code VISCOSITY_RATIO} * {@link FlowableFluid#getFlowSpeed}.
* For flowable fluids, the viscosity should match {@code VISCOSITY_RATIO} * {@link FlowableFluid#getMaxFlowDistance}.
*/
public static final int VISCOSITY_RATIO = 200;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ default int getTemperature(FluidVariant variant) {
* Return a positive integer, representing the viscosity of this fluid.
* Fluids with lower viscosity generally flow faster than fluids with higher viscosity.
*
* <p>More precisely, viscosity should be {@value FluidConstants#VISCOSITY_RATIO} * {@link FlowableFluid#getFlowSpeed} for flowable fluids.
* <p>More precisely, viscosity should be {@value FluidConstants#VISCOSITY_RATIO} * {@link FlowableFluid#getMaxFlowDistance} for flowable fluids.
* The reference values are {@value FluidConstants#WATER_VISCOSITY} for water,
* {@value FluidConstants#LAVA_VISCOSITY_NETHER} for lava in ultrawarm dimensions (such as the nether),
* and {@value FluidConstants#LAVA_VISCOSITY} for lava in other dimensions.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ public static int getTemperature(FluidVariant variant) {
* Return a positive integer, representing the viscosity of this fluid variant.
* Fluids with lower viscosity generally flow faster than fluids with higher viscosity.
*
* <p>More precisely, viscosity should be {@value FluidConstants#VISCOSITY_RATIO} * {@link FlowableFluid#getFlowSpeed} for flowable fluids.
* <p>More precisely, viscosity should be {@value FluidConstants#VISCOSITY_RATIO} * {@link FlowableFluid#getMaxFlowDistance} for flowable fluids.
* The reference values are {@value FluidConstants#WATER_VISCOSITY} for water,
* {@value FluidConstants#LAVA_VISCOSITY_NETHER} for lava in ultrawarm dimensions (such as the nether),
* and {@value FluidConstants#LAVA_VISCOSITY} for lava in other dimensions.
Expand Down

0 comments on commit fb90e29

Please sign in to comment.