mirrors/yarn
mirrors
/
yarn
mirror of https://github.com/FabricMC/yarn.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix javadoc warnings (#1884) 

* Fix javadoc warnings

* attempt 2

* attempt 3

* last attempt

* apply juuxel's comment
This commit is contained in:
YanisBft 2020-11-20 18:31:04 +01:00 committed by GitHub
parent ea7929ac46
commit 40d713533d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 27 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
mappings/net/minecraft/client/font/TextVisitFactory.mapping
View File

@ -57,7 +57,7 @@ CLASS net/minecraft/class_5223 net/minecraft/client/font/TextVisitFactory
COMMENT COMMENT
COMMENT @return {@code true} if the full string was visited, or {@code false} indicating COMMENT @return {@code true} if the full string was visited, or {@code false} indicating
COMMENT the {@code visitor} terminated half-way COMMENT the {@code visitor} terminated half-way
COMMENT @see StringRenderable#visit(StringRenderable.StyledVisitor, Style) COMMENT @see StringVisitable#visit(StringVisitable.StyledVisitor, Style)
ARG 0 text ARG 0 text
ARG 1 style ARG 1 style
ARG 2 visitor ARG 2 visitor

4
mappings/net/minecraft/client/gui/Element.mapping
View File

@ -27,7 +27,7 @@ CLASS net/minecraft/class_364 net/minecraft/client/gui/Element
ARG 2 scanCode ARG 2 scanCode
COMMENT the unique/platform-specific scan code of the keyboard input COMMENT the unique/platform-specific scan code of the keyboard input
ARG 3 modifiers ARG 3 modifiers
COMMENT a GLFW bitfield describing the modifier keys that are held down (see {@linkplain https://www.glfw.org/docs/3.3/group__mods.html GLFW Modifier key flags}) COMMENT a GLFW bitfield describing the modifier keys that are held down (see <a href="https://www.glfw.org/docs/3.3/group__mods.html">GLFW Modifier key flags</a>)
METHOD method_25400 charTyped (CI)Z METHOD method_25400 charTyped (CI)Z
COMMENT Callback for when a character input has been captured. COMMENT Callback for when a character input has been captured.
COMMENT COMMENT
@ -105,7 +105,7 @@ CLASS net/minecraft/class_364 net/minecraft/client/gui/Element
ARG 2 scanCode ARG 2 scanCode
COMMENT the unique/platform-specific scan code of the keyboard input COMMENT the unique/platform-specific scan code of the keyboard input
ARG 3 modifiers ARG 3 modifiers
COMMENT a GLFW bitfield describing the modifier keys that are held down (see {@linkplain https://www.glfw.org/docs/3.3/group__mods.html GLFW Modifier key flags}) COMMENT a GLFW bitfield describing the modifier keys that are held down (see <a href="https://www.glfw.org/docs/3.3/group__mods.html">GLFW Modifier key flags</a>)
METHOD method_25405 isMouseOver (DD)Z METHOD method_25405 isMouseOver (DD)Z
COMMENT Checks if the mouse position is within the bound COMMENT Checks if the mouse position is within the bound
COMMENT of the element. COMMENT of the element.

4
mappings/net/minecraft/client/gui/screen/Screen.mapping
View File

@ -75,7 +75,7 @@ CLASS net/minecraft/class_437 net/minecraft/client/gui/screen/Screen
METHOD method_25426 init ()V METHOD method_25426 init ()V
COMMENT Called when a screen should be initialized. COMMENT Called when a screen should be initialized.
COMMENT COMMENT
COMMENT <p>This method is called when this screen is {@link MinecraftClient#openScreen(Screen) opened} or resized. COMMENT <p>This method is called when this screen is {@linkplain net.minecraft.client.MinecraftClient#openScreen(Screen) opened} or resized.
METHOD method_25427 sendMessage (Ljava/lang/String;)V METHOD method_25427 sendMessage (Ljava/lang/String;)V
ARG 1 message ARG 1 message
METHOD method_25428 confirmLink (Z)V METHOD method_25428 confirmLink (Z)V
@ -99,7 +99,7 @@ CLASS net/minecraft/class_437 net/minecraft/client/gui/screen/Screen
ARG 2 vOffset ARG 2 vOffset
COMMENT an offset applied to the V coordinate of the background texture COMMENT an offset applied to the V coordinate of the background texture
METHOD method_25434 renderBackgroundTexture (I)V METHOD method_25434 renderBackgroundTexture (I)V
COMMENT Renders the fullscreen {@linkplain #BACKGROUND_TEXTURE background texture} of this screen. COMMENT Renders the fullscreen {@linkplain net.minecraft.client.gui.DrawableHelper#OPTIONS_BACKGROUND_TEXTURE background texture} of this screen.
ARG 1 vOffset ARG 1 vOffset
COMMENT an offset applied to the V coordinate of the background texture COMMENT an offset applied to the V coordinate of the background texture
METHOD method_25435 getNarrationMessage ()Ljava/lang/String; METHOD method_25435 getNarrationMessage ()Ljava/lang/String;

8
mappings/net/minecraft/client/gui/screen/world/GameModeSelection.mapping
View File

@ -1,11 +1,11 @@
CLASS net/minecraft/class_5681 net/minecraft/client/gui/screen/world/GameModeSelection CLASS net/minecraft/class_5681 net/minecraft/client/gui/screen/world/GameModeSelection
FIELD field_27990 gameMode Lnet/minecraft/class_1934; FIELD field_27990 gameMode Lnet/minecraft/class_1934;
COMMENT The gamemode being chosen. @see GameMode COMMENT The {@linkplain GameMode game mode} being chosen.
FIELD field_27991 name Lnet/minecraft/class_2561; FIELD field_27991 name Lnet/minecraft/class_2561;
COMMENT The name of the gamemode. COMMENT The name of the game mode.
METHOD <init> (Ljava/lang/String;ILnet/minecraft/class_1934;)V METHOD <init> (Ljava/lang/String;ILnet/minecraft/class_1934;)V
ARG 3 gameMode ARG 3 gameMode
METHOD method_32636 getGameMode ()Lnet/minecraft/class_1934; METHOD method_32636 getGameMode ()Lnet/minecraft/class_1934;
COMMENT Gets the gamemode with the given name (i.e. enum field). @see GameMode COMMENT Gets the {@linkplain GameMode game mode} with the given name (i.e. enum field).
METHOD method_32637 getName ()Lnet/minecraft/class_2561; METHOD method_32637 getName ()Lnet/minecraft/class_2561;
COMMENT Gets the name of the given gamemode. COMMENT Gets the name of the given game mode.

2
mappings/net/minecraft/client/model/TextureDimensions.mapping
View File

@ -1,5 +1,5 @@
CLASS net/minecraft/class_5608 net/minecraft/client/model/TextureDimensions CLASS net/minecraft/class_5608 net/minecraft/client/model/TextureDimensions
COMMENT Internal class used by {@link TexturedModelPartGroup}. COMMENT Internal class used by {@link TexturedModelData}.
FIELD field_27725 width I FIELD field_27725 width I
FIELD field_27726 height I FIELD field_27726 height I
METHOD <init> (II)V METHOD <init> (II)V

2
mappings/net/minecraft/item/Item.mapping
View File

@ -178,7 +178,7 @@ CLASS net/minecraft/class_1792 net/minecraft/item/Item
COMMENT <p>By default, returns true if the item has enchantments. COMMENT <p>By default, returns true if the item has enchantments.
ARG 1 stack ARG 1 stack
METHOD method_7887 shouldSyncTagToClient ()Z METHOD method_7887 shouldSyncTagToClient ()Z
COMMENT Checks if an item should have its NBT data stored in {@link #tag} sent to the client. COMMENT Checks if an item should have its NBT data stored in {@link ItemStack#tag} sent to the client.
COMMENT COMMENT
COMMENT <p>If an item is damageable, this method is ignored and data is always synced to client. COMMENT <p>If an item is damageable, this method is ignored and data is always synced to client.
METHOD method_7888 inventoryTick (Lnet/minecraft/class_1799;Lnet/minecraft/class_1937;Lnet/minecraft/class_1297;IZ)V METHOD method_7888 inventoryTick (Lnet/minecraft/class_1799;Lnet/minecraft/class_1937;Lnet/minecraft/class_1297;IZ)V

4
mappings/net/minecraft/network/packet/s2c/play/ChunkDeltaUpdateS2CPacket.mapping
View File

@ -1,7 +1,9 @@
CLASS net/minecraft/class_2637 net/minecraft/network/packet/s2c/play/ChunkDeltaUpdateS2CPacket CLASS net/minecraft/class_2637 net/minecraft/network/packet/s2c/play/ChunkDeltaUpdateS2CPacket
FIELD field_26345 sectionPos Lnet/minecraft/class_4076; FIELD field_26345 sectionPos Lnet/minecraft/class_4076;
FIELD field_26346 positions [S FIELD field_26346 positions [S
COMMENT The packed local positions {@see ChunkSectionPos#getPackedLocalPos} for each entry in {@see #blockStates}. COMMENT The packed local positions for each entry in {@link #blockStates}.
COMMENT
COMMENT @see ChunkSectionPos#packLocal(BlockPos)
FIELD field_26347 blockStates [Lnet/minecraft/class_2680; FIELD field_26347 blockStates [Lnet/minecraft/class_2680;
METHOD <init> (Lnet/minecraft/class_4076;Lit/unimi/dsi/fastutil/shorts/ShortSet;Lnet/minecraft/class_2826;Z)V METHOD <init> (Lnet/minecraft/class_4076;Lit/unimi/dsi/fastutil/shorts/ShortSet;Lnet/minecraft/class_2826;Z)V
ARG 1 sectionPos ARG 1 sectionPos

2
mappings/net/minecraft/particle/ParticleType.mapping
View File

@ -3,7 +3,7 @@ CLASS net/minecraft/class_2396 net/minecraft/particle/ParticleType
FIELD field_11197 parametersFactory Lnet/minecraft/class_2394$class_2395; FIELD field_11197 parametersFactory Lnet/minecraft/class_2394$class_2395;
METHOD <init> (ZLnet/minecraft/class_2394$class_2395;)V METHOD <init> (ZLnet/minecraft/class_2394$class_2395;)V
ARG 1 alwaysShow ARG 1 alwaysShow
COMMENT whether this particle type should appear regardless of {@linkplain GameOptions#particles particle mode} COMMENT whether this particle type should appear regardless of {@linkplain net.minecraft.client.options.GameOptions#particles particle mode}
ARG 2 parametersFactory ARG 2 parametersFactory
METHOD method_10298 getParametersFactory ()Lnet/minecraft/class_2394$class_2395; METHOD method_10298 getParametersFactory ()Lnet/minecraft/class_2394$class_2395;
METHOD method_10299 shouldAlwaysSpawn ()Z METHOD method_10299 shouldAlwaysSpawn ()Z

4
mappings/net/minecraft/text/StringVisitable.mapping
View File

@ -47,7 +47,7 @@ CLASS net/minecraft/class_5348 net/minecraft/text/StringVisitable
COMMENT COMMENT
COMMENT <p>When a {@link Optional#isPresent() present optional} is returned, COMMENT <p>When a {@link Optional#isPresent() present optional} is returned,
COMMENT the visit is terminated before visiting all text. Can return {@link COMMENT the visit is terminated before visiting all text. Can return {@link
COMMENT StringRenderable#TERMINATE_VISIT} for convenience.</p> COMMENT StringVisitable#TERMINATE_VISIT} for convenience.</p>
COMMENT COMMENT
COMMENT @return {@code Optional.empty()} to continue, a non-empty result to terminate COMMENT @return {@code Optional.empty()} to continue, a non-empty result to terminate
ARG 1 asString ARG 1 asString
@ -63,7 +63,7 @@ CLASS net/minecraft/class_5348 net/minecraft/text/StringVisitable
COMMENT COMMENT
COMMENT <p>When a {@link Optional#isPresent() present optional} is returned, COMMENT <p>When a {@link Optional#isPresent() present optional} is returned,
COMMENT the visit is terminated before visiting all text. Can return {@link COMMENT the visit is terminated before visiting all text. Can return {@link
COMMENT StringRenderable#TERMINATE_VISIT} for convenience.</p> COMMENT StringVisitable#TERMINATE_VISIT} for convenience.</p>
COMMENT COMMENT
COMMENT @return {@code Optional.empty()} to continue, a non-empty result to terminate COMMENT @return {@code Optional.empty()} to continue, a non-empty result to terminate
ARG 1 style ARG 1 style

2
mappings/net/minecraft/util/Identifier.mapping
View File

@ -7,7 +7,7 @@ CLASS net/minecraft/class_2960 net/minecraft/util/Identifier
METHOD <init> (Ljava/lang/String;)V METHOD <init> (Ljava/lang/String;)V
COMMENT <p>Takes a string of the form {@code <namespace>:<path>}, for example {@code minecraft:iron_ingot}.</p> COMMENT <p>Takes a string of the form {@code <namespace>:<path>}, for example {@code minecraft:iron_ingot}.</p>
COMMENT <p>The string will be split (on the {@code :}) into an identifier with the specified path and namespace.</p> COMMENT <p>The string will be split (on the {@code :}) into an identifier with the specified path and namespace.</p>
COMMENT Prefer using the {@link #Identifier(java.lang.String, java.lang.String)} constructor that takes the namespace and path as individual parameters to avoid mistakes. COMMENT Prefer using the {@link net.minecraft.util.Identifier#Identifier(java.lang.String, java.lang.String) Identifier(java.lang.String, java.lang.String)} constructor that takes the namespace and path as individual parameters to avoid mistakes.
COMMENT @throws InvalidIdentifierException if the string cannot be parsed as an identifier. COMMENT @throws InvalidIdentifierException if the string cannot be parsed as an identifier.
ARG 1 id ARG 1 id
METHOD <init> (Ljava/lang/String;Ljava/lang/String;)V METHOD <init> (Ljava/lang/String;Ljava/lang/String;)V

2
mappings/net/minecraft/util/dynamic/RegistryOps.mapping
View File

@ -18,7 +18,7 @@ CLASS net/minecraft/class_5382 net/minecraft/util/dynamic/RegistryOps
COMMENT <p>This method is called by casting an arbitrary dynamic ops to a registry COMMENT <p>This method is called by casting an arbitrary dynamic ops to a registry
COMMENT reading ops.</p> COMMENT reading ops.</p>
COMMENT COMMENT
COMMENT @see RegistryReadingOps#encodeOrId(Object, Object, RegistryKey, MapCodec) COMMENT @see RegistryReadingOps#encodeOrId(Object, Object, RegistryKey, Codec)
ARG 4 allowInlineDefinitions ARG 4 allowInlineDefinitions
METHOD method_29761 getValueHolder (Lnet/minecraft/class_5321;)Lnet/minecraft/class_5382$class_5383; METHOD method_29761 getValueHolder (Lnet/minecraft/class_5321;)Lnet/minecraft/class_5382$class_5383;
ARG 1 registryRef ARG 1 registryRef

2
mappings/net/minecraft/util/dynamic/RegistryReadingOps.mapping
View File

@ -15,7 +15,7 @@ CLASS net/minecraft/class_5384 net/minecraft/util/dynamic/RegistryReadingOps
COMMENT <p>This method is called by casting an arbitrary dynamic ops to a registry COMMENT <p>This method is called by casting an arbitrary dynamic ops to a registry
COMMENT reading ops.</p> COMMENT reading ops.</p>
COMMENT COMMENT
COMMENT @see RegistryOps#decodeOrId(Object, RegistryKey, MapCodec) COMMENT @see RegistryOps#decodeOrId(Object, RegistryKey, Codec, boolean)
ARG 1 input ARG 1 input
ARG 2 prefix ARG 2 prefix
ARG 3 registryReference ARG 3 registryReference

2
mappings/net/minecraft/world/EntityView.mapping
View File

@ -76,7 +76,7 @@ CLASS net/minecraft/class_1924 net/minecraft/world/EntityView
COMMENT Computes a list of entities within some box, excluding the given entity, that are not spectators. COMMENT Computes a list of entities within some box, excluding the given entity, that are not spectators.
COMMENT COMMENT
COMMENT @return a list of entities within a box, excluding the given entity COMMENT @return a list of entities within a box, excluding the given entity
COMMENT @see #getSurroundingEntities(Entity, Box, Predicate) COMMENT @see #getOtherEntities(Entity, Box, Predicate)
COMMENT @see Entity#isSpectator() COMMENT @see Entity#isSpectator()
ARG 1 except ARG 1 except
COMMENT the entity the box logically surrounds. This entity is ignored if it is inside the box. COMMENT the entity the box logically surrounds. This entity is ignored if it is inside the box.

2
mappings/net/minecraft/world/gen/chunk/ChunkGenerator.mapping
View File

@ -3,7 +3,7 @@ CLASS net/minecraft/class_2794 net/minecraft/world/gen/chunk/ChunkGenerator
COMMENT as well as populating the generated chunks with {@linkplain net.minecraft.world.gen.feature.Feature features} and {@linkplain net.minecraft.entity.Entity entities}. COMMENT as well as populating the generated chunks with {@linkplain net.minecraft.world.gen.feature.Feature features} and {@linkplain net.minecraft.entity.Entity entities}.
COMMENT Biome placement starts here, however all vanilla and most modded chunk generators delegate this to a {@linkplain net.minecraft.world.biome.source.BiomeSource biome source}. COMMENT Biome placement starts here, however all vanilla and most modded chunk generators delegate this to a {@linkplain net.minecraft.world.biome.source.BiomeSource biome source}.
FIELD field_12761 populationSource Lnet/minecraft/class_1966; FIELD field_12761 populationSource Lnet/minecraft/class_1966;
COMMENT Used to control the population step without replacing the actual biome that comes from the original {@link biomeSource}. COMMENT Used to control the population step without replacing the actual biome that comes from the original {@link #biomeSource}.
COMMENT COMMENT
COMMENT <p>This is used by {@link FlatChunkGenerator} to overwrite biome properties like whether lakes generate, while preserving the original biome ID. COMMENT <p>This is used by {@link FlatChunkGenerator} to overwrite biome properties like whether lakes generate, while preserving the original biome ID.
FIELD field_16567 structuresConfig Lnet/minecraft/class_5311; FIELD field_16567 structuresConfig Lnet/minecraft/class_5311;

8
mappings/net/minecraft/world/gen/feature/StructureFeature.mapping
View File

@ -48,8 +48,10 @@ CLASS net/minecraft/class_3195 net/minecraft/world/gen/feature/StructureFeature
COMMENT <p> COMMENT <p>
COMMENT If the {@link StructureConfig} uses a separation setting greater than 0, the COMMENT If the {@link StructureConfig} uses a separation setting greater than 0, the
COMMENT placement will be constrained to [0, spacing - separation] within the grid cell. COMMENT placement will be constrained to [0, spacing - separation] within the grid cell.
COMMENT If a non-uniform distribution is used for placement {@see #isUniformDistribution()}, COMMENT If a non-uniform distribution is used for placement, then this also moves
COMMENT then this also moves the center towards the origin. COMMENT the center towards the origin.
COMMENT
COMMENT @see #isUniformDistribution()
ARG 1 config ARG 1 config
ARG 2 worldSeed ARG 2 worldSeed
ARG 4 placementRandom ARG 4 placementRandom
@ -68,7 +70,7 @@ CLASS net/minecraft/class_3195 net/minecraft/world/gen/feature/StructureFeature
METHOD method_28657 tryPlaceStart (Lnet/minecraft/class_5455;Lnet/minecraft/class_2794;Lnet/minecraft/class_1966;Lnet/minecraft/class_3485;JLnet/minecraft/class_1923;Lnet/minecraft/class_1959;ILnet/minecraft/class_2919;Lnet/minecraft/class_5314;Lnet/minecraft/class_3037;)Lnet/minecraft/class_3449; METHOD method_28657 tryPlaceStart (Lnet/minecraft/class_5455;Lnet/minecraft/class_2794;Lnet/minecraft/class_1966;Lnet/minecraft/class_3485;JLnet/minecraft/class_1923;Lnet/minecraft/class_1959;ILnet/minecraft/class_2919;Lnet/minecraft/class_5314;Lnet/minecraft/class_3037;)Lnet/minecraft/class_3449;
COMMENT Tries to place a starting point for this type of structure in the given chunk. COMMENT Tries to place a starting point for this type of structure in the given chunk.
COMMENT <p> COMMENT <p>
COMMENT If this structure doesn't have a starting point in the chunk, {@link StructureStart.DEFAULT} COMMENT If this structure doesn't have a starting point in the chunk, {@link StructureStart#DEFAULT}
COMMENT will be returned. COMMENT will be returned.
ARG 5 worldSeed ARG 5 worldSeed
ARG 9 referenceCount ARG 9 referenceCount