Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix Javadoc links to JSR 305 annotations where feasible
Prior to this commit, we only (indirectly) configured external Javadoc links for types in the javax.annotation package for JSR 250, since those types are part of Java 8 SE. However, an external Javadoc link for types from JSR 305 was not configured. To address this issue, this commit now configures an external Javadoc link for JSR 305 types. However, the external Javadoc link for JSR 305 must be configured last to ensure that types from JSR 250 (such as @PostConstruct) are still supported. This is due to the fact that JSR 250 and JSR 305 both define types in javax.annotation, which results in a split package, and the javadoc tool does not support split packages across multiple external Javadoc sites. Instead, the Javadoc tool iterates over all external links, and the first external site that claims to support a given package (via the package-list file) wins. This means: - Javadoc for JSR 250 annotations is fully supported. - Javadoc for JSR 305 annotations in the javax.annotation package will continue to result in a 404 (page not found) error. - Javadoc for JSR 305 annotations in the javax.annotation.meta package is fully supported. For Spring Framework 6.0, the Javadoc for JSR 250 types in jakarta.annotation package is served from the JBoss Application Server Javadoc site instead of from Oracle's Java SE documentation site, since JSR 250 annotations are no longer included in Java SE. Closes gh-27904
- Loading branch information