Improve how the build deals with javadoc invalid references #30428
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
This commit improves how the build deals with javadoc invalid references in two ways. Link/see references that are temporarily invalid during javadoc generation of individual modules are better masked by using the option `Xdoclint:syntax` instead of `Xdoclint:none` (warnings were still visible in some cases, e.g. when individually building the javadoc for a specific module). Global javadoc-building task `api` now combines `syntax` and `reference` `Xdoclint` groups, allowing to raise truly invalid references even when all the modules have been aggregated. This commit also fixes the 20+ errors which appeared following the later change in doclet configuration.
simonbasle
added
type: documentation
This commit removes the JBoss Application Server external javadoc link, which covers too many packages and can thus problematically take precedence for said packages and lead to dead links. It is replaced by Hibernate javadocs for `org.hibernate.*` packages, JakartaEE and jsr305 for annotations. We lose a limited number of links around org.xnio classes and Hibernate-and-JTA-related classes, as a trade-off. See spring-projectsgh-30455
simonbasle
added a commit
that referenced
this pull request
May 16, 2023
This commit removes the JBoss Application Server external javadoc link, which covers too many packages and can thus problematically take precedence for said packages and lead to dead links. It is replaced by Hibernate javadocs for `org.hibernate.*` packages, JakartaEE and jsr305 for annotations. We lose a limited number of links around org.xnio classes and Hibernate-and-JTA-related classes, as a trade-off. See gh-30455 See gh-30428
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.
This commit improves how the build deals with javadoc invalid references
in two ways.
Link/see references that are temporarily invalid during javadoc
generation of individual modules are better masked by using the option
Xdoclint:syntaxinstead ofXdoclint:none(warnings were stillvisible in some cases, e.g. when individually building the javadoc for
a specific module).
Global javadoc-building task
apinow combinessyntaxandreferenceXdoclintgroups, allowing to raise truly invalid references even whenall the modules have been aggregated.
This commit also fixes the 20+ errors which appeared following the later
change in doclet configuration.