From 1721e42988425b7c88e8dca068076a68ccd26762 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20Basl=C3=A9?= Date: Thu, 11 May 2023 16:51:28 +0200 Subject: [PATCH] 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 --- build.gradle | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/build.gradle b/build.gradle index 534bcc8f77d..3e6b0c1fc54 100644 --- a/build.gradle +++ b/build.gradle @@ -115,10 +115,10 @@ configure([rootProject] + javaProjects) { project -> ext.javadocLinks = [ "https://docs.oracle.com/en/java/javase/17/docs/api/", "https://jakarta.ee/specifications/platform/9/apidocs/", - "https://docs.oracle.com/cd/E13222_01/wls/docs90/javadocs/", // CommonJ - "https://www.ibm.com/docs/api/v1/content/SSEQTP_8.5.5/com.ibm.websphere.javadoc.doc/web/apidocs/", - "https://docs.jboss.org/jbossas/javadoc/4.0.5/connector/", - "https://docs.jboss.org/jbossas/javadoc/7.1.2.Final/", + "https://docs.oracle.com/cd/E13222_01/wls/docs90/javadocs/", // CommonJ and weblogic.* packages + "https://www.ibm.com/docs/api/v1/content/SSEQTP_8.5.5/com.ibm.websphere.javadoc.doc/web/apidocs/", // com.ibm.* + "https://docs.jboss.org/jbossas/javadoc/4.0.5/connector/", // org.jboss.resource.* + "https://docs.jboss.org/hibernate/orm/5.6/javadocs/", "https://www.eclipse.org/aspectj/doc/released/aspectj5rt-api/", "https://www.quartz-scheduler.org/api/2.3.0/", "https://www.javadoc.io/doc/com.fasterxml.jackson.core/jackson-core/2.14.1/", @@ -134,11 +134,9 @@ configure([rootProject] + javaProjects) { project -> "https://www.reactive-streams.org/reactive-streams-1.0.3-javadoc/", "https://javadoc.io/static/io.rsocket/rsocket-core/1.1.1/", "https://r2dbc.io/spec/1.0.0.RELEASE/api/", - // The external Javadoc link for JSR 305 must come 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. + // Previously there could be a split-package issue between JSR250 and JSR305 javax.annotation packages, + // but since 6.0 JSR 250 annotations such as @Resource and @PostConstruct have been replaced by their + // JakartaEE equivalents in the jakarta.annotation package. "https://www.javadoc.io/doc/com.google.code.findbugs/jsr305/3.0.2/" ] as String[] }