Skip to content

Commit 1721e42

Browse files
committed
Remove JBossAS catch-all javadoc external link
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
1 parent eabb846 commit 1721e42

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

build.gradle

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,10 @@ configure([rootProject] + javaProjects) { project ->
115115
ext.javadocLinks = [
116116
"https://docs.oracle.com/en/java/javase/17/docs/api/",
117117
"https://jakarta.ee/specifications/platform/9/apidocs/",
118-
"https://docs.oracle.com/cd/E13222_01/wls/docs90/javadocs/", // CommonJ
119-
"https://www.ibm.com/docs/api/v1/content/SSEQTP_8.5.5/com.ibm.websphere.javadoc.doc/web/apidocs/",
120-
"https://docs.jboss.org/jbossas/javadoc/4.0.5/connector/",
121-
"https://docs.jboss.org/jbossas/javadoc/7.1.2.Final/",
118+
"https://docs.oracle.com/cd/E13222_01/wls/docs90/javadocs/", // CommonJ and weblogic.* packages
119+
"https://www.ibm.com/docs/api/v1/content/SSEQTP_8.5.5/com.ibm.websphere.javadoc.doc/web/apidocs/", // com.ibm.*
120+
"https://docs.jboss.org/jbossas/javadoc/4.0.5/connector/", // org.jboss.resource.*
121+
"https://docs.jboss.org/hibernate/orm/5.6/javadocs/",
122122
"https://www.eclipse.org/aspectj/doc/released/aspectj5rt-api/",
123123
"https://www.quartz-scheduler.org/api/2.3.0/",
124124
"https://www.javadoc.io/doc/com.fasterxml.jackson.core/jackson-core/2.14.1/",
@@ -134,11 +134,9 @@ configure([rootProject] + javaProjects) { project ->
134134
"https://www.reactive-streams.org/reactive-streams-1.0.3-javadoc/",
135135
"https://javadoc.io/static/io.rsocket/rsocket-core/1.1.1/",
136136
"https://r2dbc.io/spec/1.0.0.RELEASE/api/",
137-
// The external Javadoc link for JSR 305 must come last to ensure that types from
138-
// JSR 250 (such as @PostConstruct) are still supported. This is due to the fact
139-
// that JSR 250 and JSR 305 both define types in javax.annotation, which results
140-
// in a split package, and the javadoc tool does not support split packages
141-
// across multiple external Javadoc sites.
137+
// Previously there could be a split-package issue between JSR250 and JSR305 javax.annotation packages,
138+
// but since 6.0 JSR 250 annotations such as @Resource and @PostConstruct have been replaced by their
139+
// JakartaEE equivalents in the jakarta.annotation package.
142140
"https://www.javadoc.io/doc/com.google.code.findbugs/jsr305/3.0.2/"
143141
] as String[]
144142
}

0 commit comments

Comments
 (0)