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

Update CONVENTIONS.md 

Co-authored-by: Juuz <6596629+Juuxel@users.noreply.github.com>
This commit is contained in:
YanisBft 2023-09-05 14:42:38 +02:00 committed by GitHub
parent d2400b9e0a
commit 953ee43839
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 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. Note that ending tags such as `</p>` are not mandatory for Javadocs to render correctly.
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.