docs: Eliminate all maven-javadoc-plugin warnings#83
Closed
thced wants to merge 1 commit into
Closed
Conversation
thced
force-pushed
the
chore/javadoc-warnings
branch
2 times, most recently
from
dbc1a45 to
eb7e096
Compare
Adds detailed but concise javadoc across the public API and internal
implementation classes so `mvn package` runs the attached-javadocs goal
without any warnings (previously 174). No code behaviour changes.
Also adds an explicit no-arg constructor with javadoc to
FormTypeMapper, FormUrlEncodedParser, NotFoundHandler, TextPlainParser,
and TextTypeMapper so the synthesised default constructor no longer
trips doclint, and imports ValidationException in Validator to resolve
the {@link} references in its contract javadoc.
thced
force-pushed
the
chore/javadoc-warnings
branch
from
eb7e096 to
c10a395
Compare
|
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Adds detailed but concise javadoc across the public API and internal implementation classes so
mvn packageruns the attached-javadocs goal without any warnings (previously 174). No code behaviour changes.Also adds an explicit no-arg constructor with javadoc to FormTypeMapper, FormUrlEncodedParser, NotFoundHandler, TextPlainParser, and TextTypeMapper so the synthesised default constructor no longer trips doclint, and imports ValidationException in Validator to resolve the {@link} references in its contract javadoc.