return inlining, up to enchantment package (FabricMC#2461)

* return inlining, up to enchantment package

see FabricMC#2454

Signed-off-by: liach <[email protected]>

* Apply suggestions from code review

Typos

Co-authored-by: liach <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

mappings/net/minecraft/block/AbstractBlock.mapping

@@ -545,7 +545,7 @@ CLASS net/minecraft/class_4970 net/minecraft/block/AbstractBlock
 			ARG 1 world
 			ARG 2 pos
 		METHOD method_26213 getLuminance ()I
-			COMMENT Returns the light level emitted by this block state.
+			COMMENT {@return the light level emitted by this block state}
 		METHOD method_26214 getHardness (Lnet/minecraft/class_1922;Lnet/minecraft/class_2338;)F
 			ARG 1 world
 			ARG 2 pos

mappings/net/minecraft/block/BlockWithEntity.mapping

@@ -1,6 +1,6 @@
 CLASS net/minecraft/class_2237 net/minecraft/block/BlockWithEntity
 	METHOD method_31618 checkType (Lnet/minecraft/class_2591;Lnet/minecraft/class_2591;Lnet/minecraft/class_5558;)Lnet/minecraft/class_5558;
-		COMMENT Returns the ticker if the given type and expected type are the same, or null if they are different.
+		COMMENT {@return the ticker if the given type and expected type are the same, or {@code null} if they are different}
 		ARG 0 givenType
 		ARG 1 expectedType
 		ARG 2 ticker

mappings/net/minecraft/block/FluidDrainable.mapping

@@ -1,6 +1,6 @@
 CLASS net/minecraft/class_2263 net/minecraft/block/FluidDrainable
 	METHOD method_32351 getBucketFillSound ()Ljava/util/Optional;
-		COMMENT Returns the sound played when filling a bucket with the fluid contained in this block.
+		COMMENT {@return the sound played when filling a bucket with the fluid contained in this block}
 		COMMENT
 		COMMENT @see net.minecraft.fluid.Fluid#getBucketFillSound()
 	METHOD method_9700 tryDrainFluid (Lnet/minecraft/class_1936;Lnet/minecraft/class_2338;Lnet/minecraft/class_2680;)Lnet/minecraft/class_1799;

mappings/net/minecraft/block/PointedDripstoneBlock.mapping

@@ -97,7 +97,7 @@ CLASS net/minecraft/class_5689 net/minecraft/block/PointedDripstoneBlock
 		ARG 4 stopPredicate
 		ARG 5 range
 	METHOD method_33273 isFluidLiquid (Lnet/minecraft/class_3611;)Z
-		COMMENT Returns whether the provided {@code fluid} is liquid, namely lava or water.
+		COMMENT {@return whether the provided {@code fluid} is liquid, namely lava or water}
 		ARG 0 fluid
 	METHOD method_33274 (Lnet/minecraft/class_3611;Lnet/minecraft/class_2680;)Z
 		ARG 1 state

mappings/net/minecraft/block/entity/AbstractFurnaceBlockEntity.mapping

@@ -51,8 +51,8 @@ CLASS net/minecraft/class_2609 net/minecraft/block/entity/AbstractFurnaceBlockEn
 	METHOD method_17763 dropExperienceForRecipesUsed (Lnet/minecraft/class_3222;)V
 		ARG 1 player
 	METHOD method_26395 isNonFlammableWood (Lnet/minecraft/class_1792;)Z
-		COMMENT Returns whether the provided {@code item} is in the {@link
-		COMMENT net.minecraft.tag.ItemTags#NON_FLAMMABLE_WOOD non_flammable_wood} tag.
+		COMMENT {@return whether the provided {@code item} is in the {@link
+		COMMENT net.minecraft.tag.ItemTags#NON_FLAMMABLE_WOOD non_flammable_wood} tag}
 		ARG 0 item
 	METHOD method_27354 getRecipesUsedAndDropExperience (Lnet/minecraft/class_3218;Lnet/minecraft/class_243;)Ljava/util/List;
 		ARG 1 world

mappings/net/minecraft/client/font/Font.mapping

@@ -2,6 +2,4 @@ CLASS net/minecraft/class_390 net/minecraft/client/font/Font
 	METHOD method_2040 getGlyph (I)Lnet/minecraft/class_383;
 		ARG 1 codePoint
 	METHOD method_27442 getProvidedGlyphs ()Lit/unimi/dsi/fastutil/ints/IntSet;
-		COMMENT Returns the set of code points for which this font can provide glyphs.
-		COMMENT
-		COMMENT @return a set of integer code points.
+		COMMENT {@return the set of code points for which this font can provide glyphs}

mappings/net/minecraft/client/font/TextHandler.mapping

@@ -6,16 +6,16 @@ CLASS net/minecraft/class_5225 net/minecraft/client/font/TextHandler
 		ARG 1 style
 		ARG 2 text
 	METHOD method_27482 getWidth (Ljava/lang/String;)F
-		COMMENT Returns the width of a string.
+		COMMENT {@return the width of a string}
 		ARG 1 text
 	METHOD method_27483 moveCursorByWords (Ljava/lang/String;IIZ)I
 		ARG 0 text
 		ARG 1 offset
 		ARG 2 cursor
 		ARG 3 consumeSpaceOrBreak
 	METHOD method_27484 getTrimmedLength (Ljava/lang/String;ILnet/minecraft/class_2583;)I
-		COMMENT Returns the length of a string when it is trimmed to be at most {@code
-		COMMENT maxWidth} wide.
+		COMMENT {@return the length of a string when it is trimmed to be at most {@code
+		COMMENT maxWidth} wide}
 		ARG 1 text
 			COMMENT the string to trim
 		ARG 2 maxWidth
@@ -36,12 +36,10 @@ CLASS net/minecraft/class_5225 net/minecraft/client/font/TextHandler
 		ARG 1 style
 		ARG 2 text
 	METHOD method_27488 getWidth (Lnet/minecraft/class_5348;)F
-		COMMENT Returns the width of a text.
+		COMMENT {@return the width of a text}
 		ARG 1 text
 	METHOD method_27489 getStyleAt (Lnet/minecraft/class_5348;I)Lnet/minecraft/class_2583;
-		COMMENT Gets the style at the {@code x} position in a text.
-		COMMENT
-		COMMENT @return a style
+		COMMENT {@return the style at the {@code x} position in a text}
 		ARG 1 text
 		ARG 2 x
 			COMMENT the position in the text
@@ -181,7 +179,7 @@ CLASS net/minecraft/class_5225 net/minecraft/client/font/TextHandler
 	CLASS class_5231 WidthRetriever
 		COMMENT A retriever of character width.
 		METHOD getWidth (ILnet/minecraft/class_2583;)F
-			COMMENT Returns the width of a character.
+			COMMENT {@return the width of a character}
 			ARG 1 codePoint
 				COMMENT the character's code point
 			ARG 2 style

mappings/net/minecraft/client/font/TextVisitFactory.mapping

@@ -3,8 +3,8 @@ CLASS net/minecraft/class_5223 net/minecraft/client/font/TextVisitFactory
 	COMMENT code points and formatting codes.
 	FIELD field_24215 VISIT_TERMINATED Ljava/util/Optional;
 	METHOD method_27471 validateSurrogates (Ljava/lang/String;)Ljava/lang/String;
-		COMMENT Returns a new string that has all surrogate characters within validated
-		COMMENT from an original string.
+		COMMENT {@return a new string that has all surrogate characters within}
+		COMMENT The characters are validated from an original string {@code text}.
 		ARG 0 text
 			COMMENT the original string
 	METHOD method_27472 visitFormatted (Ljava/lang/String;ILnet/minecraft/class_2583;Lnet/minecraft/class_5224;)Z

mappings/net/minecraft/client/gui/widget/CyclingButtonWidget.mapping

@@ -47,7 +47,7 @@ CLASS net/minecraft/class_5676 net/minecraft/client/gui/widget/CyclingButtonWidg
 	METHOD method_32610 composeGenericOptionText (Ljava/lang/Object;)Lnet/minecraft/class_5250;
 		ARG 1 value
 	METHOD method_32611 getGenericNarrationMessage ()Lnet/minecraft/class_5250;
-		COMMENT Returns a generic narration message for this button.
+		COMMENT {@return a generic narration message for this button}
 		COMMENT
 		COMMENT <p>If the button omits the option text in rendering, such as showing only
 		COMMENT "Value", this narration message will still read out the option like

mappings/net/minecraft/client/network/ClientPlayerEntity.mapping

@@ -49,15 +49,13 @@ CLASS net/minecraft/class_746 net/minecraft/client/network/ClientPlayerEntity
 	METHOD method_20623 isWalking ()Z
 	METHOD method_22119 shouldAutoJump ()Z
 	METHOD method_22120 hasMovementInput ()Z
-		COMMENT Returns whether the player has movement input.
-		COMMENT
-		COMMENT @return True if the player has movement input, else false.
+		COMMENT {@return whether the player has movement input}
 	METHOD method_22419 showsDeathScreen ()Z
 	METHOD method_22420 setShowsDeathScreen (Z)V
 		ARG 1 shouldShow
 	METHOD method_26269 getMoodPercentage ()F
-		COMMENT Returns the percentage for the biome mood sound for the debug HUD to
-		COMMENT display.
+		COMMENT {@return the percentage for the biome mood sound for the debug HUD to
+		COMMENT display}
 	METHOD method_30672 (Lnet/minecraft/class_2680;Lnet/minecraft/class_2338;)Z
 		ARG 1 state
 		ARG 2 pos
@@ -77,7 +75,7 @@ CLASS net/minecraft/class_746 net/minecraft/client/network/ClientPlayerEntity
 	METHOD method_3138 updateHealth (F)V
 		ARG 1 health
 	METHOD method_3140 getUnderwaterVisibility ()F
-		COMMENT Returns the color multiplier of vision in water, so that visibility in
+		COMMENT {@return the color multiplier of vision in water} Visibility in
 		COMMENT water is reduced when the player just entered water.
 	METHOD method_3141 onRecipeDisplayed (Lnet/minecraft/class_1860;)V
 		ARG 1 recipe

mappings/net/minecraft/client/network/ServerInfo.mapping

@@ -21,7 +21,7 @@ CLASS net/minecraft/class_642 net/minecraft/client/network/ServerInfo
 	METHOD method_2989 setIcon (Ljava/lang/String;)V
 		ARG 1 icon
 	METHOD method_2990 getResourcePackPolicy ()Lnet/minecraft/class_642$class_643;
-		COMMENT Returns the policy on resource packs sent by this server.
+		COMMENT {@return the policy on resource packs sent by this server}
 	METHOD method_2991 getIcon ()Ljava/lang/String;
 	METHOD method_2992 toNbt ()Lnet/minecraft/class_2487;
 	METHOD method_2993 fromNbt (Lnet/minecraft/class_2487;)Lnet/minecraft/class_642;

mappings/net/minecraft/client/particle/Particle.mapping

@@ -78,7 +78,7 @@ CLASS net/minecraft/class_703 net/minecraft/client/particle/Particle
 	METHOD method_3087 scale (F)Lnet/minecraft/class_703;
 		ARG 1 scale
 	METHOD method_34019 getGroup ()Ljava/util/Optional;
-		COMMENT Returns the optional group that this particle belongs to.
+		COMMENT {@return the optional group that this particle belongs to}
 		COMMENT
 		COMMENT <p>A particle group restricts the number of particles from the group that
 		COMMENT can be rendered in a client world. If the particle does not have a group,

mappings/net/minecraft/client/particle/ParticleGroup.mapping

@@ -13,5 +13,5 @@ CLASS net/minecraft/class_5878 net/minecraft/client/particle/ParticleGroup
 		ARG 1 maxCount
 			COMMENT the maximum number of a type of particle allowed
 	METHOD method_34045 getMaxCount ()I
-		COMMENT Returns the maximum count of particles from this group that can be
-		COMMENT rendered in a particle manager.
+		COMMENT {@return the maximum count of particles from this group that can be
+		COMMENT rendered in a particle manager}

mappings/net/minecraft/client/particle/ParticleManager.mapping

@@ -74,8 +74,8 @@ CLASS net/minecraft/class_702 net/minecraft/client/particle/ParticleManager
 		ARG 2 parameters
 	METHOD method_3062 registerDefaultFactories ()V
 	METHOD method_34021 canAdd (Lnet/minecraft/class_5878;)Z
-		COMMENT Returns if another particle from {@code group} can be rendered by this
-		COMMENT manager.
+		COMMENT {@return whether another particle from {@code group} can be rendered by this
+		COMMENT manager}
 		ARG 1 group
 	METHOD method_34022 addTo (Lnet/minecraft/class_5878;I)V
 		ARG 1 group

mappings/net/minecraft/client/realms/gui/FetchRateLimiter.mapping

@@ -5,4 +5,4 @@ CLASS net/minecraft/class_5785 net/minecraft/client/realms/gui/FetchRateLimiter
 	METHOD method_33421 onRun ()V
 		COMMENT Notifies the tracker that the tracked task is run.
 	METHOD method_33422 getRemainingPeriod ()J
-		COMMENT Returns the time left before the next scheduled run of the tracked task.
+		COMMENT {@return the time left before the next scheduled run of the tracked task}

mappings/net/minecraft/client/render/SkyProperties.mapping

@@ -14,10 +14,8 @@ CLASS net/minecraft/class_5294 net/minecraft/client/render/SkyProperties
 		ARG 5 darkened
 	METHOD method_28108 getCloudsHeight ()F
 	METHOD method_28109 getFogColorOverride (FF)[F
-		COMMENT Returns a fog color override based on the current sky angle. This is used in vanilla to render sunset and
-		COMMENT sunrise fog.
-		COMMENT
-		COMMENT @return an RGBA array of four floats, or {@code null} if fog color should not be overridden
+		COMMENT {@return an RGBA fog color override based on the current sky angle, or {@code null} if fog color should not be overridden}
+		COMMENT This is used in vanilla to render sunset and sunrise fog.
 		ARG 1 skyAngle
 		ARG 2 tickDelta
 	METHOD method_28110 useThickFog (II)Z

mappings/net/minecraft/client/render/entity/LivingEntityRenderer.mapping

@@ -12,7 +12,7 @@ CLASS net/minecraft/class_922 net/minecraft/client/render/entity/LivingEntityRen
 		ARG 1 entity
 		ARG 2 tickDelta
 	METHOD method_23622 getOverlay (Lnet/minecraft/class_1309;F)I
-		COMMENT Returns the packed overlay color for an entity, determined by its death progress and whether it is flashing.
+		COMMENT {@return the packed overlay color for an entity} It is determined by the entity's death progress and whether the entity is flashing.
 		ARG 0 entity
 		ARG 1 whiteOverlayProgress
 	METHOD method_24302 getRenderLayer (Lnet/minecraft/class_1309;ZZZ)Lnet/minecraft/class_1921;
@@ -22,9 +22,8 @@ CLASS net/minecraft/class_922 net/minecraft/client/render/entity/LivingEntityRen
 		ARG 3 translucent
 		ARG 4 showOutline
 	METHOD method_25450 isShaking (Lnet/minecraft/class_1309;)Z
-		COMMENT Returns if this entity is shaking in the way a zombie villager,
+		COMMENT {@return if this entity is shaking} Specifically, in the way a zombie villager,
 		COMMENT zombie, husk, or piglin undergoing conversion shakes.
-		COMMENT husk, or piglin are undergoing conversion.
 		ARG 1 entity
 	METHOD method_4039 getLyingAngle (Lnet/minecraft/class_1309;)F
 		ARG 1 entity

mappings/net/minecraft/client/texture/Sprite.mapping

@@ -82,7 +82,7 @@ CLASS net/minecraft/class_1058 net/minecraft/client/texture/Sprite
 			ARG 3 to
 			ARG 4 from
 		METHOD method_24130 getPixelColor (Lnet/minecraft/class_1058$class_5790;IIII)I
-			COMMENT Returns the pixel color at frame {@code frameIndex} within mipmap {@code layer} at sprite relative coordinates.
+			COMMENT {@return the pixel color at frame {@code frameIndex} within mipmap {@code layer} at sprite relative coordinates}
 			ARG 1 animation
 			ARG 2 frameIndex
 			ARG 3 layer

mappings/net/minecraft/client/tutorial/TutorialManager.mapping

@@ -29,7 +29,7 @@ CLASS net/minecraft/class_1156 net/minecraft/client/tutorial/TutorialManager
 		ARG 2 slotStack
 		ARG 3 clickType
 	METHOD method_4905 isInSurvival ()Z
-		COMMENT Returns whether the current game mode of the client is {@linkplain net.minecraft.world.GameMode#SURVIVAL survival}.
+		COMMENT {@return whether the current game mode of the client is {@linkplain net.minecraft.world.GameMode#SURVIVAL survival}}
 	METHOD method_4906 onSlotUpdate (Lnet/minecraft/class_1799;)V
 		ARG 1 stack
 	METHOD method_4907 onBlockBreaking (Lnet/minecraft/class_638;Lnet/minecraft/class_2338;Lnet/minecraft/class_2680;F)V

mappings/net/minecraft/enchantment/Enchantment.mapping

@@ -10,20 +10,20 @@ CLASS net/minecraft/class_1887 net/minecraft/enchantment/Enchantment
 	METHOD method_20742 getMaxPower (I)I
 		ARG 1 level
 	METHOD method_25949 isAvailableForEnchantedBookOffer ()Z
-		COMMENT Returns whether this enchantment will appear in the enchanted book trade
-		COMMENT offers of librarian villagers.
+		COMMENT {@return whether this enchantment will appear in the enchanted book trade
+		COMMENT offers of librarian villagers}
 	METHOD method_25950 isAvailableForRandomSelection ()Z
-		COMMENT Returns whether this enchantment will appear in the enchanting table or
-		COMMENT loots with random enchant function.
+		COMMENT {@return whether this enchantment will appear in the enchanting table or
+		COMMENT loots with random enchant function}
 	METHOD method_8178 onUserDamaged (Lnet/minecraft/class_1309;Lnet/minecraft/class_1297;I)V
 		ARG 1 user
 		ARG 2 attacker
 		ARG 3 level
 	METHOD method_8179 getName (I)Lnet/minecraft/class_2561;
 		ARG 1 level
 	METHOD method_8180 canAccept (Lnet/minecraft/class_1887;)Z
-		COMMENT Returns whether this enchantment can exist on an item stack with the
-		COMMENT {@code other} enchantment.
+		COMMENT {@return whether this enchantment can exist on an item stack with the
+		COMMENT {@code other} enchantment}
 		ARG 1 other
 	METHOD method_8181 getProtectionAmount (ILnet/minecraft/class_1282;)I
 		ARG 1 level
@@ -37,9 +37,9 @@ CLASS net/minecraft/class_1887 net/minecraft/enchantment/Enchantment
 	METHOD method_8186 getRarity ()Lnet/minecraft/class_1887$class_1888;
 	METHOD method_8187 getMinLevel ()I
 	METHOD method_8188 canCombine (Lnet/minecraft/class_1887;)Z
-		COMMENT Returns whether this enchantment can exist on an item stack with the
+		COMMENT {@return whether this enchantment can exist on an item stack with the
 		COMMENT {@code other} enchantment and the {@code other} enchantment can exist
-		COMMENT with this enchantment.
+		COMMENT with this enchantment}
 		ARG 1 other
 	METHOD method_8189 onTargetDamaged (Lnet/minecraft/class_1309;Lnet/minecraft/class_1297;I)V
 		ARG 1 user
@@ -64,4 +64,4 @@ CLASS net/minecraft/class_1887 net/minecraft/enchantment/Enchantment
 		METHOD <init> (Ljava/lang/String;II)V
 			ARG 3 weight
 		METHOD method_8197 getWeight ()I
-			COMMENT Returns the weight of an enchantment in weighted pickers.
+			COMMENT {@return the weight of an enchantment in weighted pickers}

mappings/net/minecraft/enchantment/EnchantmentHelper.mapping

@@ -7,8 +7,8 @@ CLASS net/minecraft/class_1890 net/minecraft/enchantment/EnchantmentHelper
 		COMMENT Loads enchantments from an NBT list.
 		ARG 0 list
 	METHOD method_24365 chooseEquipmentWith (Lnet/minecraft/class_1887;Lnet/minecraft/class_1309;Ljava/util/function/Predicate;)Ljava/util/Map$Entry;
-		COMMENT Returns a pair of an equipment slot and the item stack in the supplied
-		COMMENT entity's slot, indicating the item stack has the enchantment supplied
+		COMMENT {@return a pair of an equipment slot and the item stack in the supplied
+		COMMENT entity's slot} It indicates the item stack has the enchantment supplied
 		COMMENT and fulfills the extra condition.
 		COMMENT
 		COMMENT <p>If multiple equipment slots' item stacks are valid, a random pair is
@@ -31,22 +31,22 @@ CLASS net/minecraft/class_1890 net/minecraft/enchantment/EnchantmentHelper
 	METHOD method_8200 hasAquaAffinity (Lnet/minecraft/class_1309;)Z
 		ARG 0 entity
 	METHOD method_8201 isCompatible (Ljava/util/Collection;Lnet/minecraft/class_1887;)Z
-		COMMENT Returns whether the {@code candidate} enchantment is compatible with the
-		COMMENT {@code existing} enchantments.
+		COMMENT {@return whether the {@code candidate} enchantment is compatible with the
+		COMMENT {@code existing} enchantments}
 		ARG 0 existing
 		ARG 1 candidate
 	METHOD method_8202 getRiptide (Lnet/minecraft/class_1799;)I
 		ARG 0 stack
 	METHOD method_8203 getEquipmentLevel (Lnet/minecraft/class_1887;Lnet/minecraft/class_1309;)I
-		COMMENT Returns the highest level of the passed enchantment in the enchantment's
-		COMMENT applicable equipment slots' item stacks.
+		COMMENT {@return the highest level of the passed enchantment in the enchantment's
+		COMMENT applicable equipment slots' item stacks}
 		ARG 0 enchantment
 			COMMENT the enchantment
 		ARG 1 entity
 			COMMENT the entity whose equipment slots are checked
 	METHOD method_8204 chooseEquipmentWith (Lnet/minecraft/class_1887;Lnet/minecraft/class_1309;)Ljava/util/Map$Entry;
-		COMMENT Returns a pair of an equipment slot and the item stack in the supplied
-		COMMENT entity's slot, indicating the item stack has the enchantment supplied.
+		COMMENT {@return a pair of an equipment slot and the item stack in the supplied
+		COMMENT entity's slot} It indicates the item stack has the enchantment supplied.
 		COMMENT
 		COMMENT <p>If multiple equipment slots' item stacks are valid, a random pair is
 		COMMENT returned.
@@ -125,8 +125,8 @@ CLASS net/minecraft/class_1890 net/minecraft/enchantment/EnchantmentHelper
 	METHOD method_8226 getLooting (Lnet/minecraft/class_1309;)I
 		ARG 0 entity
 	METHOD method_8227 calculateRequiredExperienceLevel (Ljava/util/Random;IILnet/minecraft/class_1799;)I
-		COMMENT Returns the required experience level for an enchanting option in the
-		COMMENT enchanting table's screen, or the enchantment screen.
+		COMMENT {@return the required experience level for an enchanting option in the
+		COMMENT enchanting table's screen, or the enchantment screen}
 		ARG 0 random
 			COMMENT the random, which guarantees consistent results with the same seed
 		ARG 1 slotIndex