Skip to content

Commit 81ba8b6

Browse files
committed
Refine javadoc links
See gh-41614
1 parent dc49c64 commit 81ba8b6

File tree

3 files changed

+15
-7
lines changed

3 files changed

+15
-7
lines changed

buildSrc/src/main/java/org/springframework/boot/build/antora/AntoraAsciidocAttributes.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,11 +207,15 @@ private void addUrlJava(Map<String, String> attributes) {
207207
attributes.put("javadoc-location-java-lang", "{url-javase-javadoc}/java.base");
208208
attributes.put("javadoc-location-java-net", "{url-javase-javadoc}/java.base");
209209
attributes.put("javadoc-location-java-io", "{url-javase-javadoc}/java.base");
210+
attributes.put("javadoc-location-java-nio", "{url-javase-javadoc}/java.base");
211+
attributes.put("javadoc-location-java-security", "{url-javase-javadoc}/java.base");
212+
attributes.put("javadoc-location-java-sql", "{url-javase-javadoc}/java.sql");
210213
attributes.put("javadoc-location-java-time", "{url-javase-javadoc}/java.base");
211214
attributes.put("javadoc-location-java-util", "{url-javase-javadoc}/java.base");
212215
attributes.put("javadoc-location-javax-management", "{url-javase-javadoc}/java.management");
213216
attributes.put("javadoc-location-javax-net", "{url-javase-javadoc}/java.base");
214217
attributes.put("javadoc-location-javax-sql", "{url-javase-javadoc}/java.sql");
218+
attributes.put("javadoc-location-javax-security", "{url-javase-javadoc}/java.base");
215219
attributes.put("javadoc-location-javax-xml", "{url-javase-javadoc}/java.xml");
216220
}
217221

buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ url-jackson-dataformat-xml-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.
102102
javadoc-location-org-apache-pulsar-client-api={url-pulsar-client-api-javadoc}
103103
javadoc-location-org-apache-pulsar-reactive-client-api={url-pulsar-client-reactive-api-javadoc}
104104
javadoc-location-org-springframework-data-cassandra={url-spring-data-cassandra-javadoc}
105+
javadoc-location-org-springframework-data-convert={url-spring-data-commons-javadoc}
105106
javadoc-location-org-springframework-data-querydsl={url-spring-data-commons-javadoc}
106107
javadoc-location-org-springframework-data-repository={url-spring-data-commons-javadoc}
107108
javadoc-location-org-springframework-data-couchbase={url-spring-data-couchbase-javadoc}

spring-boot-project/spring-boot-dependencies/build.gradle

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ bom {
6161
}
6262
links {
6363
site("https://activemq.apache.org/components/artemis")
64+
javadoc("https://javadoc.io/doc/org.apache.activemq/artemis-jms-server/{version}", "org.apache.activemq.artemis.jms.server")
6465
releaseNotes("https://activemq.apache.org/components/artemis/download/release-notes-{version}")
6566
}
6667
}
@@ -176,6 +177,7 @@ bom {
176177
}
177178
links {
178179
site("https://github.com/ben-manes/caffeine")
180+
javadoc("https://javadoc.io/doc/com.github.ben-manes.caffeine/caffeine/{version}", "com.github.benmanes.caffeine")
179181
docs("https://github.com/ben-manes/caffeine/wiki")
180182
releaseNotes("https://github.com/ben-manes/caffeine/releases/tag/v{version}")
181183
}
@@ -448,7 +450,7 @@ bom {
448450
}
449451
links {
450452
site("https://www.graphql-java.com/")
451-
javadoc("https://javadoc.io/doc/com.graphql-java/graphql-java/{version}", "graphql")
453+
javadoc("https://javadoc.io/doc/com.graphql-java/graphql-java/{version}", "graphql.schema", "graphql.execution")
452454
releaseNotes("https://github.com/graphql-java/graphql-java/releases/tag/v{version}")
453455
}
454456
}
@@ -957,6 +959,7 @@ bom {
957959
}
958960
links {
959961
site("https://github.com/eclipse-ee4j/jersey")
962+
javadoc("https://javadoc.io/doc/org.glassfish.jersey.core/jersey-server/{version}", "org.glassfish.jersey.server")
960963
releaseNotes("https://github.com/eclipse-ee4j/jersey/releases/tag/{version}")
961964
}
962965
}
@@ -980,7 +983,7 @@ bom {
980983
}
981984
links {
982985
site("https://eclipse.dev/jetty")
983-
javadoc(version -> "https://javadoc.jetty.org/jetty-%s".formatted(version.major()))
986+
javadoc(version -> "https://javadoc.jetty.org/jetty-%s".formatted(version.major()), "org.eclipse.jetty")
984987
releaseNotes("https://github.com/jetty/jetty.project/releases/tag/jetty-{version}")
985988
}
986989
}
@@ -1197,8 +1200,8 @@ bom {
11971200
}
11981201
links {
11991202
site("https://logging.apache.org/log4j")
1200-
javadoc("log4j-api", version -> "https://logging.apache.org/log4j/%s.x/javadoc/log4j-api/index.html".formatted(version.major()))
1201-
javadoc("log4j-core", version -> "https://logging.apache.org/log4j/%s.x/javadoc/log4j-core/index.html".formatted(version.major()))
1203+
javadoc("log4j-api", version -> "https://logging.apache.org/log4j/%s.x/javadoc/log4j-api".formatted(version.major()))
1204+
javadoc("log4j-core", version -> "https://logging.apache.org/log4j/%s.x/javadoc/log4j-core".formatted(version.major()), "org.apache.logging.log4j.core")
12021205
docs(version -> "https://logging.apache.org/log4j/%s.x/manual".formatted(version.major()))
12031206
releaseNotes("https://github.com/apache/logging-log4j2/releases/tag/rel%2F{version}")
12041207
}
@@ -1212,7 +1215,7 @@ bom {
12121215
}
12131216
links {
12141217
site("https://logback.qos.ch")
1215-
javadoc("https://logback.qos.ch/apidocs")
1218+
javadoc("https://logback.qos.ch/apidocs", "ch.qos.logback")
12161219
}
12171220
}
12181221
library("Lombok", "1.18.36") {
@@ -1586,7 +1589,7 @@ bom {
15861589
site("https://github.com/open-telemetry/opentelemetry-java")
15871590
javadoc("opentelemetry-api", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-api/%s".formatted(version), "io.opentelemetry.api")
15881591
javadoc("opentelemetry-context", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-context/%s".formatted(version), "io.opentelemetry.context")
1589-
javadoc("opentelemetry-sdk-common", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-common/%s".formatted(version), "io.opentelemetry.sdk.common")
1592+
javadoc("opentelemetry-sdk-common", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-common/%s".formatted(version), "io.opentelemetry.sdk.common", "io.opentelemetry.sdk.resources")
15901593
javadoc("opentelemetry-sdk-logs", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-logs/%s".formatted(version), "io.opentelemetry.sdk.logs")
15911594
javadoc("opentelemetry-sdk-metrics", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-metrics/%s".formatted(version), "io.opentelemetry.sdk.metrics")
15921595
javadoc("opentelemetry-sdk-trace", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-trace/%s".formatted(version), "io.opentelemetry.sdk.trace")
@@ -2449,7 +2452,7 @@ bom {
24492452
}
24502453
links {
24512454
site("https://tomcat.apache.org")
2452-
javadoc(version -> "https://tomcat.apache.org/tomcat-%s.%s-doc/api".formatted(version.major(), version.minor()), "org.apache.catalina")
2455+
javadoc(version -> "https://tomcat.apache.org/tomcat-%s.%s-doc/api".formatted(version.major(), version.minor()), "org.apache.catalina", "org.apache.tomcat")
24532456
docs(version -> "https://tomcat.apache.org/tomcat-%s.%s-doc".formatted(version.major(), version.minor()))
24542457
releaseNotes(version -> "https://tomcat.apache.org/tomcat-%s.%s-doc/changelog.html".formatted(version.major(), version.minor()))
24552458
}

0 commit comments

Comments
 (0)