Fix javadoc

This commit is contained in:
apple502j 2024-03-24 00:43:51 +09:00
parent 0cc5cd834f
commit fee340db58
No known key found for this signature in database
GPG Key ID: 2A69798565A099A9
5 changed files with 18 additions and 20 deletions

View File

@ -247,7 +247,7 @@ CLASS net/minecraft/class_1657 net/minecraft/entity/player/PlayerEntity
COMMENT whether the held item is effective for that block, otherwise
COMMENT it returns {@code true}.
COMMENT
COMMENT @see net.minecraft.item.Item#isSuitableFor(BlockState)
COMMENT @see net.minecraft.item.ItemStack#isSuitableFor(BlockState)
ARG 1 state
METHOD method_7308 getShoulderEntityRight ()Lnet/minecraft/class_2487;
METHOD method_7311 openEditSignScreen (Lnet/minecraft/class_2625;Z)V

View File

@ -18,22 +18,22 @@ CLASS net/minecraft/class_8934 net/minecraft/inventory/LootableInventory
COMMENT <p>This is usually stored under the {@value LOOT_TABLE_SEED_KEY} NBT key.
ARG 1 lootTableSeed
METHOD method_54867 setLootTable (Lnet/minecraft/class_5321;J)V
COMMENT Sets the loot table ID and seed at once.
COMMENT Sets the loot table and seed at once.
COMMENT This is useful for code-based structure generation.
COMMENT
COMMENT @see #setLootTableId(Identifier)
COMMENT @see #setLootTable(RegistryKey)
COMMENT @see #setLootTableSeed(long)
COMMENT @see #setLootTable(BlockView, Random, BlockPos, Identifier)
COMMENT @see #setLootTable(BlockView, Random, BlockPos, RegistryKey)
ARG 1 lootTableId
ARG 2 lootTableSeed
METHOD method_54868 setLootTable (Lnet/minecraft/class_1922;Lnet/minecraft/class_5819;Lnet/minecraft/class_2338;Lnet/minecraft/class_5321;)V
COMMENT Queries the block entity at {@code pos}, checks if it is a {@link LootableInventory},
COMMENT and sets the loot table ID and seed if applicable.
COMMENT and sets the loot table and seed if applicable.
COMMENT This is useful for code-based structure generation.
COMMENT
COMMENT @see #setLootTableId(Identifier)
COMMENT @see #setLootTable(RegistryKey)
COMMENT @see #setLootTableSeed(long)
COMMENT @see #setLootTable(Identifier, long)
COMMENT @see #setLootTable(RegistryKey, long)
ARG 0 world
ARG 1 random
ARG 2 pos
@ -47,21 +47,21 @@ CLASS net/minecraft/class_8934 net/minecraft/inventory/LootableInventory
COMMENT
COMMENT <p>This is usually stored under the {@value LOOT_TABLE_SEED_KEY} NBT key.
METHOD method_54871 readLootTable (Lnet/minecraft/class_2487;)Z
COMMENT Reads the loot table ID and seed from {@code nbt}, if the loot table ID
COMMENT Reads the loot table and seed from {@code nbt}, if the loot table
COMMENT exists in {@code nbt}. Implementations should skip reading the contents of
COMMENT the inventory if this returns {@code true}.
COMMENT
COMMENT @return whether the loot table ID was found
COMMENT @return whether the loot table was found
ARG 1 nbt
METHOD method_54872 writeLootTable (Lnet/minecraft/class_2487;)Z
COMMENT Writes the loot table ID and seed to {@code nbt}, if {@linkplain #getLootTableId
COMMENT the loot table ID} is not {@code null}. Implementations should skip writing the
COMMENT Writes the loot table and seed to {@code nbt}, if {@linkplain #getLootTable
COMMENT the loot table} is not {@code null}. Implementations should skip writing the
COMMENT contents of the inventory if this returns {@code true}.
COMMENT
COMMENT <p>This skips writing the seed if it equals {@code 0L}. This has no practical
COMMENT difference in-game, as getting nonexistent {@code long} values return {@code 0L}.
COMMENT
COMMENT @return whether the loot table ID was non-{@code null}
COMMENT @return whether the loot table was non-{@code null}
ARG 1 nbt
METHOD method_54873 generateLoot (Lnet/minecraft/class_1657;)V
COMMENT Replaces the contents of this inventory with the generated loot, if it exists.

View File

@ -441,7 +441,7 @@ CLASS net/minecraft/class_1799 net/minecraft/item/ItemStack
COMMENT net.minecraft.advancement.criterion.Criteria#ITEM_DURABILITY_CHANGED}.
COMMENT
COMMENT <p>When the item "breaks", that is, the stack's damage is equal to or above
COMMENT {@linkplain Item#getMaxDamage the maximum damage}, {@code breakCallback} is run.
COMMENT {@linkplain #getMaxDamage the maximum damage}, {@code breakCallback} is run.
COMMENT Callers should decrement the stack size inside the callback.
ARG 1 amount
ARG 2 random
@ -461,10 +461,10 @@ CLASS net/minecraft/class_1799 net/minecraft/item/ItemStack
METHOD method_7963 isDamageable ()Z
COMMENT {@return whether the item can be damaged (lose durability)}
COMMENT
COMMENT <p>Items with {@linkplain Item#getMaxDamage 0 max damage} or item stacks with {@link
COMMENT <p>Items with {@linkplain #getMaxDamage 0 max damage} or item stacks with {@link
COMMENT net.minecraft.component.DataComponentTypes#UNBREAKABLE} component cannot be damaged.
COMMENT
COMMENT @see Item#getMaxDamage
COMMENT @see #getMaxDamage
COMMENT @see #isDamaged
COMMENT @see #getDamage
METHOD method_7964 getName ()Lnet/minecraft/class_2561;
@ -483,7 +483,7 @@ CLASS net/minecraft/class_1799 net/minecraft/item/ItemStack
COMMENT <p>If {@code entity} is a player, this triggers {@link
COMMENT net.minecraft.advancement.criterion.Criteria#ITEM_DURABILITY_CHANGED}.
COMMENT
COMMENT <p>If the stack's damage is equal to or above {@linkplain Item#getMaxDamage the maximum
COMMENT <p>If the stack's damage is equal to or above {@linkplain #getMaxDamage the maximum
COMMENT damage} (i.e. the item is "broken"), this will {@linkplain
COMMENT LivingEntity#sendEquipmentBreakStatus send the equipment break status}, decrement the
COMMENT stack, and increment {@link net.minecraft.stat.Stats#BROKEN} if the stack is held
@ -528,7 +528,7 @@ CLASS net/minecraft/class_1799 net/minecraft/item/ItemStack
METHOD method_7974 setDamage (I)V
COMMENT Sets the stack's damage to {@code damage}.
COMMENT
COMMENT <p>This does not break the item if the damage reaches {@linkplain Item#getMaxDamage
COMMENT <p>This does not break the item if the damage reaches {@linkplain #getMaxDamage
COMMENT the maximum}, unlike {@link #damage(int, LivingEntity, EquipmentSlot)}.
COMMENT
COMMENT @see #getDamage

View File

@ -27,8 +27,6 @@ CLASS net/minecraft/class_1832 net/minecraft/item/ToolMaterial
METHOD method_8027 getMiningSpeedMultiplier ()F
COMMENT {@return the mining speed bonus applied when a {@link net.minecraft.item.ToolItem} using this material is breaking an appropriate block}
COMMENT {@code 1.0f} will result in no speed change.
COMMENT <p>
COMMENT <b>Note:</b> for default vanilla tool classes, this bonus is only applied in {@link net.minecraft.item.MiningToolItem#getMiningSpeedMultiplier(ItemStack, BlockState)}.
METHOD method_8028 getAttackDamage ()F
COMMENT {@return the attack damage bonus applied to any {@link net.minecraft.item.ToolItem} using this {@link ToolMaterial}}
COMMENT <p>

View File

@ -320,7 +320,7 @@ CLASS net/minecraft/class_6088 net/minecraft/world/WorldEvents
FIELD field_46805 CRAFTER_CRAFTS I
COMMENT A crafter crafts an item.
COMMENT <br>Plays the crafter craft sound event.
COMMENT <p>Called by {@link net.minecraft.block.CrafterBlock#transferOrSpawnStack(net.minecraft.world.World, net.minecraft.util.math.BlockPos, net.minecraft.block.entity.CrafterBlockEntity, net.minecraft.item.ItemStack, net.minecraft.block.BlockState) CrafterBlock#transferOrSpawnStack}
COMMENT <p>Called by {@link net.minecraft.block.CrafterBlock#transferOrSpawnStack CrafterBlock#transferOrSpawnStack}
FIELD field_46806 CRAFTER_FAILS I
COMMENT A crafter fails to craft.
COMMENT <br>Plays the crafter fail sound event.