Add javadocs convention (#1790)

* Add javadocs convention

* Update CONVENTIONS.md
This commit is contained in:
YanisBft 2020-10-13 09:56:22 +02:00 committed by GitHub
parent 6cc1a9368a
commit 83d6b1581d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 1 deletions

View File

@ -43,6 +43,7 @@ time to type thanks to IDE autocompletion. Common abbreviations you should use a
- "pos" for "position"
- "nbt" for "named binary tag"
- "init" for "initialize"
- "min"/"max" for "minimum"/"maximum"
- Any abbreviations used by Java or libraries ("json", "html", etc.)
Treat acronyms as single words rather than capitalising every letter. This improves readability (compare `JsonObject` and
@ -113,6 +114,14 @@ front of the coordinate (`velocityX`, not `xVelocity`).
Name screen coordinates `x` and `y`, rather than `left` and `top`.
## Javadocs
Write sentences for class, method and fields 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.
Write quick descriptions for parameter javadocs as well as `@return` tags, with no uppercase or period. Add parameter docs to the parameter itself instead of using the `@param` tag.
Use `@link`, `@linkplain` and `@see` tags to refer to other parts of the code.
## Mojang names
**Do not use names from Mojang's obfuscation maps.**

View File

@ -1,5 +1,5 @@
# Done to increase the memory available to gradle.
org.gradle.jvmargs=-Xmx1G
enigma_version=0.21+build.218
enigma_version=0.21.4+build.225
stitch_version=0.5.1+build.77