mmo-ref/mc-fabric-api
1
0
Fork 0
mirror of https://github.com/FabricMC/fabric synced 2026-08-19 06:26:07 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix javadoc errors resulting from the migration to official names

Browse source
This commit is contained in:
PepperCode1 2025-12-17 14:13:04 -08:00
parent 9c919daca4
commit 3e7aa8de44
14 changed files with 21 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

6
fabric-client-gametest-api-v1/src/client/java/net/fabricmc/fabric/api/client/gametest/v1/package-info.java
View file

@ -70,7 +70,7 @@
* <td>Consistency of tests</td>
* </tr>
* <tr>
* <td>{@linkplain net.minecraft.client.Options#cloudStatus()} Cloud render mode}</td>
* <td>{@linkplain net.minecraft.client.Options#cloudStatus() Cloud render mode}</td>
* <td>{@link net.minecraft.client.CloudStatus#OFF OFF}</td>
* <td>{@link net.minecraft.client.CloudStatus#FANCY FANCY}</td>
* <td>Consistency of tests</td>
@ -82,14 +82,14 @@
* <td>Would cause the game test runner to have to click through the onboard accessibility prompt</td>
* </tr>
* <tr>
* <td>{@linkplain net.minecraft.client.Options#renderDistance()} View distance}</td>
* <td>{@linkplain net.minecraft.client.Options#renderDistance() View distance}</td>
* <td>{@code 5}</td>
* <td>{@code 10}</td>
* <td>Speeds up loading of chunks, especially for functions such as
* {@link net.fabricmc.fabric.api.client.gametest.v1.context.TestClientWorldContext#waitForChunksRender() TestClientWorldContext.waitForChunksRender()}</td>
* </tr>
* <tr>
* <td>{@linkplain net.minecraft.client.Options#getSoundSourceOptionInstance(net.minecraft.sounds.SoundSource)} Music volume}</td>
* <td>{@linkplain net.minecraft.client.Options#getSoundSourceOptionInstance(net.minecraft.sounds.SoundSource) Music volume}</td>
* <td>{@code 0.0}</td>
* <td>{@code 1.0}</td>
* <td>The game music is annoying while running gametests</td>

2
fabric-data-generation-api-v1/src/main/java/net/fabricmc/fabric/api/datagen/v1/provider/FabricDynamicRegistryProvider.java
View file

@ -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 <T> void add(Holder.Reference<T> object, ResourceCondition... conditions) {

4
fabric-entity-events-v1/src/main/java/net/fabricmc/fabric/api/entity/event/v1/EntitySleepEvents.java
View file

@ -100,7 +100,7 @@ public final class EntitySleepEvents {
* If {@code false}, the player wakes up.
*
* <p>This event is only checked <i>during</i> 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);
}

2
fabric-events-interaction-v0/src/main/java/net/fabricmc/fabric/api/event/player/UseEntityCallback.java
View file

@ -47,7 +47,7 @@ import net.fabricmc.fabric.api.event.EventFactory;
* </ul>
*
* <p>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 {

2
fabric-item-api-v1/src/main/java/net/fabricmc/fabric/api/item/v1/EquipmentSlotProvider.java
View file

@ -26,7 +26,7 @@ import net.minecraft.world.item.ItemStack;
* an armor slot that they can go in.
*
* <p>The preferred equipment slot of an item stack can be queried using
* {@link LivingEntity#getEquipmentSlotForItem(ItemStack)} LivingEntity.getPreferredEquipmentSlot()}.
* {@link LivingEntity#getEquipmentSlotForItem(ItemStack) LivingEntity.getPreferredEquipmentSlot()}.
*
* <p>Equipment slot providers can be set with {@link FabricItem.Settings#equipmentSlot(EquipmentSlotProvider)}.
*

4
fabric-message-api-v1/src/client/java/net/fabricmc/fabric/api/client/message/v1/ClientReceiveMessageEvents.java
View file

@ -65,7 +65,7 @@ public final class ClientReceiveMessageEvents {
*
* <p>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<AllowGame> ALLOW_GAME = EventFactory.createArrayBacked(AllowGame.class, listeners -> (message, overlay) -> {
boolean allow = true;
@ -173,7 +173,7 @@ public final class ClientReceiveMessageEvents {
*
* <p>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

2
fabric-networking-api-v1/src/main/java/net/fabricmc/fabric/api/networking/v1/EntityTrackingEvents.java
View file

@ -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<StartTracking> START_TRACKING = EventFactory.createArrayBacked(StartTracking.class, callbacks -> (trackedEntity, player) -> {
for (StartTracking callback : callbacks) {

2
fabric-particles-v1/src/main/java/net/fabricmc/fabric/api/particle/v1/FabricBlockStateParticleEffect.java
View file

@ -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
*/

2
fabric-recipe-api-v1/src/main/java/net/fabricmc/fabric/api/recipe/v1/ingredient/FabricIngredient.java
View file

@ -40,7 +40,7 @@ public interface FabricIngredient {
* and custom ingredients need to {@linkplain CustomIngredient#requiresTesting() provide this information}.
*
* <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#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.
*
* <p>If {@code true}, the ingredient must always be tested using {@link Ingredient#test(ItemStack)}.

6
fabric-renderer-api-v1/src/client/java/net/fabricmc/fabric/api/renderer/v1/mesh/MutableQuadView.java
View file

@ -318,9 +318,9 @@ public interface MutableQuadView extends QuadView {
* Controls whether vertex colors should be modified for ambient occlusion.
*
* <p>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}.
*
* <p>The default value is {@link TriState#DEFAULT}.
*
@ -332,7 +332,7 @@ public interface MutableQuadView extends QuadView {
* Controls how glint should be applied.
*
* <p>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.
*
* <p>The default value is {@code null}.

2
fabric-renderer-api-v1/src/client/java/net/fabricmc/fabric/api/renderer/v1/render/FabricLayerRenderState.java
View file

@ -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

2
fabric-rendering-v1/src/client/java/net/fabricmc/fabric/api/client/rendering/v1/SpecialGuiElementRegistry.java
View file

@ -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}.
*
* <p>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 {
/**

2
fabric-screen-handler-api-v1/src/main/java/net/fabricmc/fabric/api/screenhandler/v1/package-info.java
View file

@ -42,7 +42,7 @@
* {@link net.minecraft.world.SimpleMenuProvider} that wraps such factory.
*
* <h2>Overwriting screen handlers</h2>
* 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

4
fabric-sound-api-v1/src/client/java/net/fabricmc/fabric/api/client/sound/v1/FabricSoundInstance.java
View file

@ -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<AudioStream> getAudioStream(SoundBufferLibrary loader, Identifier id, boolean repeatInstantly) {