Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix javadoc issue and produce javadoc artifact during normal builds #594

Merged
merged 6 commits into from
Aug 4, 2021
Merged

Fix javadoc issue and produce javadoc artifact during normal builds #594

merged 6 commits into from
Aug 4, 2021

Conversation

brenuart
Copy link
Collaborator

@brenuart brenuart commented Aug 4, 2021 •
edited
Loading

  • fix javadoc issues (errors and warnings) to be compliant with JDK16
  • produce javadoc artifact during normal build (instead of waiting for a release build)
  • fail on error and warnings
  • disable fail on warnings on JDK 15+ until code is fully documented (warnings are emitted when a public/protected method is not documented)

Addresses issue #588.

@brenuart
wip
5f41734
@brenuart
Fix javadoc and schedule generation during package phase
3ad5532
@brenuart
Explicitly set <version> on javadoc
37faf42 
Explicitly set version. This should help to get rid of the following warning when building the project with JDK 11+:

   The code being documented uses modules but the packages defined in
   https://docs.oracle.com/javase/8/docs/api/ are in the unnamed module.
@brenuart
Correct header numbering in javadoc
690997b 
Fix issue: "heading used out of sequence: <H3>, compared to implicit preceding heading: <H1>"
@brenuart
Disable failure on warnings for JDK 15+
220bb92 
Doclint emits a warning when a public/protected method is missing javadoc on JDK 15+. Disable this feature until the code is fully documented.
@brenuart
Revert changes to Jackson API links
7d3011e
@brenuart brenuart merged commit 3e19421 into main Aug 4, 2021
@brenuart brenuart deleted the gh588-javadoc branch August 4, 2021 17:23
@brenuart brenuart linked an issue Aug 4, 2021 that may be closed by this pull request
Fix javadoc issues and generate javadoc during normal builds #588
Closed
philsttr
philsttr reviewed Aug 28, 2021
View reviewed changes
pom.xml
<goals>
<goal>jar</goal>
</goals>
<phase>package</phase>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit The default phase of the jar goal is package, so the phase does not need to be configured here.

@philsttr philsttr added this to the 7.0 milestone Aug 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@philsttr philsttr philsttr left review comments

Assignees
No one assigned
Labels
type/enhancement
Projects
None yet
Milestone
7.0
Development

Successfully merging this pull request may close these issues.

Fix javadoc issues and generate javadoc during normal builds
2 participants
@brenuart @philsttr