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

Remove remaining paragraph ending tags (#3654) 

* Remove remaining paragraph ending tags

* Update CONVENTIONS.md

Co-authored-by: Juuz <6596629+Juuxel@users.noreply.github.com>

---------

Co-authored-by: Juuz <6596629+Juuxel@users.noreply.github.com>
This commit is contained in:
YanisBft 2023-09-08 17:54:03 +02:00 committed by GitHub
parent f5f0803fec
commit e4f311ec61
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONVENTIONS.md
View File

@ -117,7 +117,7 @@ Name screen coordinates `x` and `y`, rather than `left` and `top`.
## Javadocs
Write sentences for class, method and field javadocs, starting with an uppercase and ending with a period. Start method docs with verbs, like `Gets` or `Called`. Use HTML tags such as `<p>` if the docs have several paragraphs, as line wraps are converted to spaces in the generated documentation. Feel free to start a new line whenever you feel the current line is too long.
Write sentences for class, method and field javadocs, starting with an uppercase and ending with a period. Start method docs with verbs, like `Gets` or `Called`. Use HTML tags such as `<p>` if the docs have several paragraphs, as line wraps are converted to spaces in the generated documentation. Feel free to start a new line whenever you feel the current line is too long. Note that some ending tags such as `</p>` are not mandatory for Javadocs to render correctly.
Parameter and `@return` documentation should use quick descriptions without initial capitalization or punctuation, such as `{@code true} if the block placement was successful, {@code false} otherwise`. `{@return}` used in the first sentence can duplicate enclosed text to the return description.

4
mappings/net/minecraft/entity/player/PlayerInventory.mapping
View File

@ -6,7 +6,7 @@ CLASS net/minecraft/class_1661 net/minecraft/entity/player/PlayerInventory
FIELD field_30639 OFF_HAND_SLOT I
COMMENT Zero-based index of the offhand slot.
COMMENT
COMMENT <p>This value is the result of the sum {@code MAIN_SIZE (36) + ARMOR_SIZE (4)}.</p>
COMMENT <p>This value is the result of the sum {@code MAIN_SIZE (36) + ARMOR_SIZE (4)}.
FIELD field_30640 NOT_FOUND I
COMMENT The slot index ({@value}) used to indicate no result
COMMENT (item not present / no available space) when querying the inventory's contents
@ -14,7 +14,7 @@ CLASS net/minecraft/class_1661 net/minecraft/entity/player/PlayerInventory
FIELD field_30641 HOTBAR_SIZE I
COMMENT The number of columns ({@value}) in the inventory.
COMMENT
COMMENT <p>The same value dictates the size of the player's hotbar, excluding the offhand slot.</p>
COMMENT <p>The same value dictates the size of the player's hotbar, excluding the offhand slot.
FIELD field_33767 ARMOR_SLOTS [I
FIELD field_33768 HELMET_SLOTS [I
FIELD field_7542 changeCount I

4
mappings/net/minecraft/recipe/RecipeMatcher.mapping
View File

@ -9,7 +9,7 @@ CLASS net/minecraft/class_1662 net/minecraft/recipe/RecipeMatcher
METHOD method_7400 addInput (Lnet/minecraft/class_1799;)V
COMMENT Adds a full item stack to the pool of available resources.
COMMENT
COMMENT <p>This is equivalent to calling {@code addInput(stack, Item.DEFAULT_MAX_COUNT)}.</p>
COMMENT <p>This is equivalent to calling {@code addInput(stack, Item.DEFAULT_MAX_COUNT)}.
ARG 1 stack
METHOD method_7401 addInput (II)V
COMMENT Adds an input to be used for recipe matching.
@ -34,7 +34,7 @@ CLASS net/minecraft/class_1662 net/minecraft/recipe/RecipeMatcher
METHOD method_7404 addUnenchantedInput (Lnet/minecraft/class_1799;)V
COMMENT Adds a full item stack to the pool of available resources.
COMMENT
COMMENT <p>This is equivalent to calling {@code addInput(stack, Item.DEFAULT_MAX_COUNT)}.</p>
COMMENT <p>This is equivalent to calling {@code addInput(stack, Item.DEFAULT_MAX_COUNT)}.
ARG 1 stack
METHOD method_7405 getStackFromId (I)Lnet/minecraft/class_1799;
ARG 0 itemId

2
mappings/net/minecraft/recipe/ShapedRecipe.mapping
View File

@ -28,7 +28,7 @@ CLASS net/minecraft/class_1869 net/minecraft/recipe/ShapedRecipe
METHOD method_8146 removePadding (Ljava/util/List;)[Ljava/lang/String;
COMMENT Removes empty space from around the recipe pattern.
COMMENT
COMMENT <p>Turns patterns such as:</p>
COMMENT <p>Turns patterns such as:
COMMENT <pre>
COMMENT {@code
COMMENT " o"