From 3e7aa8de447dd8ee882894d525ffd64a17864e12 Mon Sep 17 00:00:00 2001 From: PepperCode1 <44146161+PepperCode1@users.noreply.github.com> Date: Wed, 17 Dec 2025 14:13:04 -0800 Subject: [PATCH] Fix javadoc errors resulting from the migration to official names --- .../fabric/api/client/gametest/v1/package-info.java | 6 +++--- .../datagen/v1/provider/FabricDynamicRegistryProvider.java | 2 +- .../fabric/api/entity/event/v1/EntitySleepEvents.java | 4 ++-- .../fabricmc/fabric/api/event/player/UseEntityCallback.java | 2 +- .../fabricmc/fabric/api/item/v1/EquipmentSlotProvider.java | 2 +- .../api/client/message/v1/ClientReceiveMessageEvents.java | 4 ++-- .../fabric/api/networking/v1/EntityTrackingEvents.java | 2 +- .../api/particle/v1/FabricBlockStateParticleEffect.java | 2 +- .../fabric/api/recipe/v1/ingredient/FabricIngredient.java | 2 +- .../fabric/api/renderer/v1/mesh/MutableQuadView.java | 6 +++--- .../api/renderer/v1/render/FabricLayerRenderState.java | 2 +- .../api/client/rendering/v1/SpecialGuiElementRegistry.java | 2 +- .../fabricmc/fabric/api/screenhandler/v1/package-info.java | 2 +- .../fabric/api/client/sound/v1/FabricSoundInstance.java | 4 ++-- 14 files changed, 21 insertions(+), 21 deletions(-) diff --git a/fabric-client-gametest-api-v1/src/client/java/net/fabricmc/fabric/api/client/gametest/v1/package-info.java b/fabric-client-gametest-api-v1/src/client/java/net/fabricmc/fabric/api/client/gametest/v1/package-info.java index dc3decb77c..47d24f61c0 100644 --- a/fabric-client-gametest-api-v1/src/client/java/net/fabricmc/fabric/api/client/gametest/v1/package-info.java +++ b/fabric-client-gametest-api-v1/src/client/java/net/fabricmc/fabric/api/client/gametest/v1/package-info.java @@ -70,7 +70,7 @@ * Consistency of tests * * - * {@linkplain net.minecraft.client.Options#cloudStatus()} Cloud render mode} + * {@linkplain net.minecraft.client.Options#cloudStatus() Cloud render mode} * {@link net.minecraft.client.CloudStatus#OFF OFF} * {@link net.minecraft.client.CloudStatus#FANCY FANCY} * Consistency of tests @@ -82,14 +82,14 @@ * Would cause the game test runner to have to click through the onboard accessibility prompt * * - * {@linkplain net.minecraft.client.Options#renderDistance()} View distance} + * {@linkplain net.minecraft.client.Options#renderDistance() View distance} * {@code 5} * {@code 10} * Speeds up loading of chunks, especially for functions such as * {@link net.fabricmc.fabric.api.client.gametest.v1.context.TestClientWorldContext#waitForChunksRender() TestClientWorldContext.waitForChunksRender()} * * - * {@linkplain net.minecraft.client.Options#getSoundSourceOptionInstance(net.minecraft.sounds.SoundSource)} Music volume} + * {@linkplain net.minecraft.client.Options#getSoundSourceOptionInstance(net.minecraft.sounds.SoundSource) Music volume} * {@code 0.0} * {@code 1.0} * The game music is annoying while running gametests diff --git a/fabric-data-generation-api-v1/src/main/java/net/fabricmc/fabric/api/datagen/v1/provider/FabricDynamicRegistryProvider.java b/fabric-data-generation-api-v1/src/main/java/net/fabricmc/fabric/api/datagen/v1/provider/FabricDynamicRegistryProvider.java index 75cbf16a1b..13deb385bf 100644 --- a/fabric-data-generation-api-v1/src/main/java/net/fabricmc/fabric/api/datagen/v1/provider/FabricDynamicRegistryProvider.java +++ b/fabric-data-generation-api-v1/src/main/java/net/fabricmc/fabric/api/datagen/v1/provider/FabricDynamicRegistryProvider.java @@ -166,7 +166,7 @@ public abstract class FabricDynamicRegistryProvider implements DataProvider { * Adds a new object to be data generated with several resource conditions. * * @param object The object to generate. This registry entry must have both a - * {@linkplain Holder#isBound()} key and value}. + * {@linkplain Holder#isBound() key and value}. * @param conditions Conditions that must be satisfied to load this object. */ public void add(Holder.Reference object, ResourceCondition... conditions) { diff --git a/fabric-entity-events-v1/src/main/java/net/fabricmc/fabric/api/entity/event/v1/EntitySleepEvents.java b/fabric-entity-events-v1/src/main/java/net/fabricmc/fabric/api/entity/event/v1/EntitySleepEvents.java index 0a23aa7b41..fc968c990f 100644 --- a/fabric-entity-events-v1/src/main/java/net/fabricmc/fabric/api/entity/event/v1/EntitySleepEvents.java +++ b/fabric-entity-events-v1/src/main/java/net/fabricmc/fabric/api/entity/event/v1/EntitySleepEvents.java @@ -100,7 +100,7 @@ public final class EntitySleepEvents { * If {@code false}, the player wakes up. * *

This event is only checked during sleeping, so an entity can - * {@linkplain LivingEntity#startSleeping(BlockPos)} start sleeping} on any block, but will immediately + * {@linkplain LivingEntity#startSleeping(BlockPos) start sleeping} on any block, but will immediately * wake up if this check fails. * * @see LivingEntity#checkBedExists() @@ -230,7 +230,7 @@ public final class EntitySleepEvents { * Called when an entity starts to sleep. * * @param entity the sleeping entity - * @param sleepingPos the {@linkplain LivingEntity#getSleepingPos()} sleeping position} of the entity + * @param sleepingPos the {@linkplain LivingEntity#getSleepingPos() sleeping position} of the entity */ void onStartSleeping(LivingEntity entity, BlockPos sleepingPos); } diff --git a/fabric-events-interaction-v0/src/main/java/net/fabricmc/fabric/api/event/player/UseEntityCallback.java b/fabric-events-interaction-v0/src/main/java/net/fabricmc/fabric/api/event/player/UseEntityCallback.java index 3818e8f8f9..cf5c17c053 100644 --- a/fabric-events-interaction-v0/src/main/java/net/fabricmc/fabric/api/event/player/UseEntityCallback.java +++ b/fabric-events-interaction-v0/src/main/java/net/fabricmc/fabric/api/event/player/UseEntityCallback.java @@ -47,7 +47,7 @@ import net.fabricmc.fabric.api.event.EventFactory; * * *

Note that on the server, the {@link EntityHitResult} may be {@code null} if the client successfully interacted using - * the {@linkplain Player#interactOn(Entity, InteractionHand)} position-less overload}. + * the {@linkplain Player#interactOn(Entity, InteractionHand) position-less overload}. * On the client, the {@link EntityHitResult} will never be null. */ public interface UseEntityCallback { diff --git a/fabric-item-api-v1/src/main/java/net/fabricmc/fabric/api/item/v1/EquipmentSlotProvider.java b/fabric-item-api-v1/src/main/java/net/fabricmc/fabric/api/item/v1/EquipmentSlotProvider.java index 13d6a59d33..b2c1c810cc 100644 --- a/fabric-item-api-v1/src/main/java/net/fabricmc/fabric/api/item/v1/EquipmentSlotProvider.java +++ b/fabric-item-api-v1/src/main/java/net/fabricmc/fabric/api/item/v1/EquipmentSlotProvider.java @@ -26,7 +26,7 @@ import net.minecraft.world.item.ItemStack; * an armor slot that they can go in. * *

The preferred equipment slot of an item stack can be queried using - * {@link LivingEntity#getEquipmentSlotForItem(ItemStack)} LivingEntity.getPreferredEquipmentSlot()}. + * {@link LivingEntity#getEquipmentSlotForItem(ItemStack) LivingEntity.getPreferredEquipmentSlot()}. * *

Equipment slot providers can be set with {@link FabricItem.Settings#equipmentSlot(EquipmentSlotProvider)}. * diff --git a/fabric-message-api-v1/src/client/java/net/fabricmc/fabric/api/client/message/v1/ClientReceiveMessageEvents.java b/fabric-message-api-v1/src/client/java/net/fabricmc/fabric/api/client/message/v1/ClientReceiveMessageEvents.java index 08c2c5da59..a3e7f742da 100644 --- a/fabric-message-api-v1/src/client/java/net/fabricmc/fabric/api/client/message/v1/ClientReceiveMessageEvents.java +++ b/fabric-message-api-v1/src/client/java/net/fabricmc/fabric/api/client/message/v1/ClientReceiveMessageEvents.java @@ -65,7 +65,7 @@ public final class ClientReceiveMessageEvents { * *

Overlay is whether the message will be displayed in the action bar. * To toggle overlay, return false and call - * {@link net.minecraft.client.player.LocalPlayer#displayClientMessage(Component, boolean)} ClientPlayerEntity.sendMessage(message, overlay)}. + * {@link net.minecraft.client.player.LocalPlayer#displayClientMessage(Component, boolean) ClientPlayerEntity.sendMessage(message, overlay)}. */ public static final Event ALLOW_GAME = EventFactory.createArrayBacked(AllowGame.class, listeners -> (message, overlay) -> { boolean allow = true; @@ -173,7 +173,7 @@ public final class ClientReceiveMessageEvents { * *

Overlay is whether the message will be displayed in the action bar. * To toggle overlay, return false and call - * {@link net.minecraft.client.player.LocalPlayer#displayClientMessage(Component, boolean)} ClientPlayerEntity.sendMessage(message, overlay)}. + * {@link net.minecraft.client.player.LocalPlayer#displayClientMessage(Component, boolean) ClientPlayerEntity.sendMessage(message, overlay)}. * * @param message the message received from the server * @param overlay whether the message will be displayed in the action bar diff --git a/fabric-networking-api-v1/src/main/java/net/fabricmc/fabric/api/networking/v1/EntityTrackingEvents.java b/fabric-networking-api-v1/src/main/java/net/fabricmc/fabric/api/networking/v1/EntityTrackingEvents.java index c81151afda..d95674de48 100644 --- a/fabric-networking-api-v1/src/main/java/net/fabricmc/fabric/api/networking/v1/EntityTrackingEvents.java +++ b/fabric-networking-api-v1/src/main/java/net/fabricmc/fabric/api/networking/v1/EntityTrackingEvents.java @@ -30,7 +30,7 @@ public final class EntityTrackingEvents { /** * An event that is called after a player has started tracking an entity. * Typically, this occurs when an entity enters a client's view distance. - * This event is called after the entity's {@linkplain Entity#getAddEntityPacket(ServerEntity)} spawn packet} is sent to the player. + * This event is called after the entity's {@linkplain Entity#getAddEntityPacket(ServerEntity) spawn packet} is sent to the player. */ public static final Event START_TRACKING = EventFactory.createArrayBacked(StartTracking.class, callbacks -> (trackedEntity, player) -> { for (StartTracking callback : callbacks) { diff --git a/fabric-particles-v1/src/main/java/net/fabricmc/fabric/api/particle/v1/FabricBlockStateParticleEffect.java b/fabric-particles-v1/src/main/java/net/fabricmc/fabric/api/particle/v1/FabricBlockStateParticleEffect.java index fbbcee57f4..de7590ab43 100644 --- a/fabric-particles-v1/src/main/java/net/fabricmc/fabric/api/particle/v1/FabricBlockStateParticleEffect.java +++ b/fabric-particles-v1/src/main/java/net/fabricmc/fabric/api/particle/v1/FabricBlockStateParticleEffect.java @@ -50,7 +50,7 @@ public interface FabricBlockStateParticleEffect { } /** - * @return the block pos from which {@linkplain BlockParticleOption#getState()} the block state} was + * @return the block pos from which {@linkplain BlockParticleOption#getState() the block state} was * retrieved, or {@code null} if not applicable or this instance was synced from a remote server that does not have * this Fabric API module installed */ diff --git a/fabric-recipe-api-v1/src/main/java/net/fabricmc/fabric/api/recipe/v1/ingredient/FabricIngredient.java b/fabric-recipe-api-v1/src/main/java/net/fabricmc/fabric/api/recipe/v1/ingredient/FabricIngredient.java index e8ed7cf0a5..7228e28458 100644 --- a/fabric-recipe-api-v1/src/main/java/net/fabricmc/fabric/api/recipe/v1/ingredient/FabricIngredient.java +++ b/fabric-recipe-api-v1/src/main/java/net/fabricmc/fabric/api/recipe/v1/ingredient/FabricIngredient.java @@ -40,7 +40,7 @@ public interface FabricIngredient { * and custom ingredients need to {@linkplain CustomIngredient#requiresTesting() provide this information}. * *

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#items()} list of matching stacks}. + * the item stack's item is included in the ingredient's {@linkplain Ingredient#items() list of matching stacks}. * In that case, optimized matching logic can be used. * *

If {@code true}, the ingredient must always be tested using {@link Ingredient#test(ItemStack)}. diff --git a/fabric-renderer-api-v1/src/client/java/net/fabricmc/fabric/api/renderer/v1/mesh/MutableQuadView.java b/fabric-renderer-api-v1/src/client/java/net/fabricmc/fabric/api/renderer/v1/mesh/MutableQuadView.java index 8061457fed..8f2870f7af 100644 --- a/fabric-renderer-api-v1/src/client/java/net/fabricmc/fabric/api/renderer/v1/mesh/MutableQuadView.java +++ b/fabric-renderer-api-v1/src/client/java/net/fabricmc/fabric/api/renderer/v1/mesh/MutableQuadView.java @@ -318,9 +318,9 @@ public interface MutableQuadView extends QuadView { * Controls whether vertex colors should be modified for ambient occlusion. * *

If set to {@link TriState#DEFAULT}, ambient occlusion will be used if the block state has - * {@linkplain BlockState#getLightEmission()} a luminance} of 0. Set to {@link TriState#TRUE} or {@link TriState#FALSE} + * {@linkplain BlockState#getLightEmission() a luminance} of 0. Set to {@link TriState#TRUE} or {@link TriState#FALSE} * to override this behavior. {@link TriState#TRUE} will not have an effect if - * {@linkplain Minecraft#useAmbientOcclusion()} ambient occlusion is disabled globally}. + * {@linkplain Minecraft#useAmbientOcclusion() ambient occlusion is disabled globally}. * *

The default value is {@link TriState#DEFAULT}. * @@ -332,7 +332,7 @@ public interface MutableQuadView extends QuadView { * Controls how glint should be applied. * *

If set to {@code null}, glint will be applied in item contexts based on - * {@linkplain ItemStackRenderState.LayerRenderState#setFoilType(ItemStackRenderState.FoilType)} the glint type of the layer}. Set + * {@linkplain ItemStackRenderState.LayerRenderState#setFoilType(ItemStackRenderState.FoilType) the glint type of the layer}. Set * to another value to override this behavior. * *

The default value is {@code null}. diff --git a/fabric-renderer-api-v1/src/client/java/net/fabricmc/fabric/api/renderer/v1/render/FabricLayerRenderState.java b/fabric-renderer-api-v1/src/client/java/net/fabricmc/fabric/api/renderer/v1/render/FabricLayerRenderState.java index ff701bff08..665d7d2e51 100644 --- a/fabric-renderer-api-v1/src/client/java/net/fabricmc/fabric/api/renderer/v1/render/FabricLayerRenderState.java +++ b/fabric-renderer-api-v1/src/client/java/net/fabricmc/fabric/api/renderer/v1/render/FabricLayerRenderState.java @@ -34,7 +34,7 @@ public interface FabricLayerRenderState { * Retrieves the {@link QuadEmitter} used to append quads to this layer. Calling this method a second time * invalidates any prior result. Geometry added to this emitter will not be visible in * {@link ItemStackRenderState.LayerRenderState#prepareQuadList()} and will be rendered after any - * {@linkplain ItemStackRenderState.LayerRenderState#prepareQuadList()} vanilla quads} when this layer is rendered. Vertex + * {@linkplain ItemStackRenderState.LayerRenderState#prepareQuadList() vanilla quads} when this layer is rendered. Vertex * positions of geometry added to this emitter will automatically be output on * {@link ItemStackRenderState#visitExtents(Consumer)} ({@link ItemStackRenderState.LayerRenderState#setExtents(Supplier)} must still * be used to add positions of {@linkplain ItemStackRenderState.LayerRenderState#prepareQuadList() vanilla quads}). Adding quads diff --git a/fabric-rendering-v1/src/client/java/net/fabricmc/fabric/api/client/rendering/v1/SpecialGuiElementRegistry.java b/fabric-rendering-v1/src/client/java/net/fabricmc/fabric/api/client/rendering/v1/SpecialGuiElementRegistry.java index cf49781b25..7ad27b68ae 100644 --- a/fabric-rendering-v1/src/client/java/net/fabricmc/fabric/api/client/rendering/v1/SpecialGuiElementRegistry.java +++ b/fabric-rendering-v1/src/client/java/net/fabricmc/fabric/api/client/rendering/v1/SpecialGuiElementRegistry.java @@ -32,7 +32,7 @@ import net.fabricmc.fabric.impl.client.rendering.SpecialGuiElementRegistryImpl; * used to render custom gui elements beyond the methods available in {@link net.minecraft.client.gui.GuiGraphics DrawContext}. * *

To render a custom gui element, first implement and register a {@link PictureInPictureRenderer}. - * When you want to render, add an instance of the corresponding render state to {@link net.minecraft.client.gui.GuiGraphics#guiRenderState DrawContext#state} using {@link net.minecraft.client.gui.render.state.GuiRenderState#submitPicturesInPictureState(net.minecraft.client.gui.render.state.pip.PictureInPictureRenderState)} GuiRenderState#addSpecialElement(SpecialGuiElementRenderState)}. + * When you want to render, add an instance of the corresponding render state to {@link net.minecraft.client.gui.GuiGraphics#guiRenderState DrawContext#state} using {@link net.minecraft.client.gui.render.state.GuiRenderState#submitPicturesInPictureState(net.minecraft.client.gui.render.state.pip.PictureInPictureRenderState) GuiRenderState#addSpecialElement(SpecialGuiElementRenderState)}. */ public final class SpecialGuiElementRegistry { /** diff --git a/fabric-screen-handler-api-v1/src/main/java/net/fabricmc/fabric/api/screenhandler/v1/package-info.java b/fabric-screen-handler-api-v1/src/main/java/net/fabricmc/fabric/api/screenhandler/v1/package-info.java index 978840016c..01ed239f53 100644 --- a/fabric-screen-handler-api-v1/src/main/java/net/fabricmc/fabric/api/screenhandler/v1/package-info.java +++ b/fabric-screen-handler-api-v1/src/main/java/net/fabricmc/fabric/api/screenhandler/v1/package-info.java @@ -42,7 +42,7 @@ * {@link net.minecraft.world.SimpleMenuProvider} that wraps such factory. * *

Overwriting screen handlers

- * You might have noticed that calling {@link net.minecraft.world.entity.player.Player#openMenu(net.minecraft.world.MenuProvider)} openHandledScreen} while on another screen will move + * You might have noticed that calling {@link net.minecraft.world.entity.player.Player#openMenu(net.minecraft.world.MenuProvider) openHandledScreen} while on another screen will move * the cursor to the center of the screen. This is because the current screen gets closed before * opening the screen, resetting the cursor position. Since this behavior can be problematic, * this API provides a way to disable this. By overriding {@link diff --git a/fabric-sound-api-v1/src/client/java/net/fabricmc/fabric/api/client/sound/v1/FabricSoundInstance.java b/fabric-sound-api-v1/src/client/java/net/fabricmc/fabric/api/client/sound/v1/FabricSoundInstance.java index b0d9aa0101..1680eefc82 100644 --- a/fabric-sound-api-v1/src/client/java/net/fabricmc/fabric/api/client/sound/v1/FabricSoundInstance.java +++ b/fabric-sound-api-v1/src/client/java/net/fabricmc/fabric/api/client/sound/v1/FabricSoundInstance.java @@ -82,8 +82,8 @@ public interface FabricSoundInstance { * @param loader The default sound loader, capable of loading {@code .ogg} files. * @param id The resolved sound ID, equal to {@link SoundInstance#getSound()}'s location. * @param repeatInstantly Whether this sound should loop. This is true when the sound - * {@linkplain SoundInstance#isLooping()} is repeatable} and has - * {@linkplain SoundInstance#getDelay()} no delay}. + * {@linkplain SoundInstance#isLooping() is repeatable} and has + * {@linkplain SoundInstance#getDelay() no delay}. * @return the loaded audio stream */ default CompletableFuture getAudioStream(SoundBufferLibrary loader, Identifier id, boolean repeatInstantly) {