From 953ee438392fb4d57c6ded8005125f43d46b893a Mon Sep 17 00:00:00 2001 From: YanisBft Date: Tue, 5 Sep 2023 14:42:38 +0200 Subject: [PATCH] Update CONVENTIONS.md Co-authored-by: Juuz <6596629+Juuxel@users.noreply.github.com> --- CONVENTIONS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONVENTIONS.md b/CONVENTIONS.md index eb49b0aa7c..c24b942479 100644 --- a/CONVENTIONS.md +++ b/CONVENTIONS.md @@ -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 `

` 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 `

` 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 `

` 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 `

` 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.