chore(docs): Fixup javadoc warnings#6995
Merged
jeremylong merged 4 commits intomainfrom Sep 29, 2024
Merged
Conversation
…ension tag @implNote
boring-cyborg
Bot
added
core
Collaborator
|
I also plan on going through the checkstyle before doing the 11.0 release. I'll try to do this tomorrow morning. |
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Description of Change
While looking at build output I spotted a series of Javadoc warnings and errors.
The changes fixup javadoc warnings on missing documentation parts and invalid HTML5 constructs. Partly by fixing the documentation and partly by removing unneeded (and undocumented) throws-clauses for exceptions that are never thrown by the method body.
Also includes a configuration fix for the javadoc plugin to make Javadoc aware of the
@implNotejavadoc tag that is standardized in Java 8, but not yet by default supported by the Javadoc tool, so that it requires explicit activation as a custom tag.Have test cases been added to cover the new functionality?
N/A