Linting: Fix multiple Javadoc Errors / Warnings #90
Conversation
This file contains hidden or 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
While delving into Citizens2, several build warnings derived from CitizensAPI. This commit addresses these otherwise benign warnings, and includes minor grammar changes. Documentation style for @param tags is preserved. It does not reflect changes where the javadoc may no longer accurately portray the described methods, or the intent behind them.
|
|
TheFlagCourier
added a commit
to TheFlagCourier/Citizens2
that referenced
this pull request
Jul 30, 2025
fullwall
pushed a commit
to CitizensDev/Citizens2
that referenced
this pull request
Jul 31, 2025
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.
While delving into Citizens2, several build warnings derived from CitizensAPI's malformed Javadocs. This commit addresses these otherwise benign warnings, and includes minor grammar changes.
@paramtag styles have been preserved. Simple comments with empty@returntags have been squashed. Blank lines have been replaced with<p>.This PR does not address issues where the docs may be otherwise deficient. I do not have enough knowledge of the code to make those assumptions.