javadoc fixes for gestalt-module #156
Open
+442
−27
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
soloturn
force-pushed
the
javadoc
branch
3 times, most recently
from
1d1a902 to
16dfb69
Compare
BenjaminAmos
requested changes
Nov 19, 2024
There was a problem hiding this comment.
At an initial glance, I have highlighted many spelling errors in the comments introduced here.
For getters, I would prefer that the description states that they return something, so "Returns a thing" is preferred over "Get a thing"/"Gets a thing".
Just because a constructor is a default constructor, that does not mean that you can describe it as "Default constructor". Even though the purpose is usually obvious, if you are aiming for complete JavaDoc coverage then we should at least make it quality documentation.
gestalt-module/src/main/java/org/terasology/gestalt/module/Module.java
Outdated
Show resolved
Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/Module.java
Outdated
Show resolved
Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/Module.java
Outdated
Show resolved
Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/Module.java
Outdated
Show resolved
Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/Module.java
Outdated
Show resolved
Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/module/sandbox/ModuleSecurityManager.java
Outdated
Show resolved
Hide resolved
...alt-module/src/main/java/org/terasology/gestalt/module/sandbox/ModuleSecurityPermission.java
Outdated
Show resolved
Hide resolved
...t-module/src/main/java/org/terasology/gestalt/module/sandbox/SetUnionPermissionProvider.java
Outdated
Show resolved
Hide resolved
...t-module/src/main/java/org/terasology/gestalt/module/sandbox/SetUnionPermissionProvider.java
Outdated
Show resolved
Hide resolved
gestalt-module/src/main/java/org/terasology/gestalt/naming/VersionRange.java
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.