Skip to content

Commit 9efb516

Browse files
committed
Add more javadoc links
See gh-41614
1 parent 2f2d65b commit 9efb516

File tree

3 files changed

+28
-2
lines changed

3 files changed

+28
-2
lines changed

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

+2
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,8 @@ private void addVersionAttributes(Map<String, String> attributes, Map<String, St
127127
addDependencyVersion(attributes, "jackson-annotations", "com.fasterxml.jackson.core:jackson-annotations");
128128
addDependencyVersion(attributes, "jackson-core", "com.fasterxml.jackson.core:jackson-core");
129129
addDependencyVersion(attributes, "jackson-databind", "com.fasterxml.jackson.core:jackson-databind");
130+
addDependencyVersion(attributes, "jackson-dataformat-xml",
131+
"com.fasterxml.jackson.dataformat:jackson-dataformat-xml");
130132
addSpringDataDependencyVersion(attributes, internal, "spring-data-commons");
131133
addSpringDataDependencyVersion(attributes, internal, "spring-data-couchbase");
132134
addSpringDataDependencyVersion(attributes, internal, "spring-data-cassandra");

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

+2
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ url-spring-data-site=https://spring.io/projects/spring-data
7575
url-jackson-annotations-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-annotations/{version-jackson-annotations}
7676
url-jackson-core-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-core/{version-jackson-core}
7777
url-jackson-databind-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-databind/{version-jackson-databind}
78+
url-jackson-dataformat-xml-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/{version-jackson-dataformat-xml}
7879

7980
# === Javadoc Locations ===
8081

@@ -92,6 +93,7 @@ javadoc-location-org-springframework-data-r2dbc={url-spring-data-r2dbc-javadoc}
9293
javadoc-location-org-springframework-data-redis={url-spring-data-redis-javadoc}
9394
javadoc-location-org-springframework-data-rest={url-spring-data-rest-javadoc}
9495
javadoc-location-com-fasterxml-jackson-databind={url-jackson-databind-javadoc}
96+
javadoc-location-com-fasterxml-jackson-dataformat-xml={url-jackson-dataformat-xml-javadoc}
9597

9698
# === API References ===
9799

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

+24-2
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,7 @@ bom {
260260
}
261261
links {
262262
site("https://docs.couchbase.com/java-sdk/current/hello-world/overview.html")
263+
javadoc("https://javadoc.io/doc/com.couchbase.client/java-client/{version}")
263264
releaseNotes("https://docs.couchbase.com/java-sdk/current/project-docs/sdk-release-notes.html")
264265
}
265266
}
@@ -552,6 +553,10 @@ bom {
552553
"HikariCP"
553554
]
554555
}
556+
links {
557+
site("https://github.com/brettwooldridge/HikariCP")
558+
javadoc("https://javadoc.io/doc/com.zaxxer/HikariCP/{version}", "com.zaxxer.hikari")
559+
}
555560
}
556561
library("HSQLDB", "2.7.4") {
557562
group("org.hsqldb") {
@@ -800,6 +805,13 @@ bom {
800805
"jakarta.websocket-client-api"
801806
]
802807
}
808+
links {
809+
releaseNotes("https://github.com/jakartaee/jaxb-api/releases/tag/{version}")
810+
javadoc("jakarta-websocket-server", version -> "https://jakarta.ee/specifications/websocket/%s.%s/apidocs/server"
811+
.formatted(version.major(), version.minor()), "jakarta.websocket.server")
812+
javadoc("jakarta-websocket-client", version -> "https://jakarta.ee/specifications/websocket/%s.%s/apidocs/client"
813+
.formatted(version.major(), version.minor()), "jakarta.websocket")
814+
}
803815
}
804816
library("Jakarta WS RS", "3.1.0") {
805817
group("jakarta.ws.rs") {
@@ -816,6 +828,8 @@ bom {
816828
}
817829
links {
818830
releaseNotes("https://github.com/jakartaee/jaxb-api/releases/tag/{version}")
831+
javadoc(version -> "https://jakarta.ee/specifications/xml-binding/%s.%s/apidocs"
832+
.formatted(version.major(), version.minor()), "jakarta.xml.bind")
819833
}
820834
}
821835
library("Jakarta XML SOAP", "3.0.2") {
@@ -948,6 +962,7 @@ bom {
948962
}
949963
links {
950964
site("https://eclipse.dev/jetty")
965+
javadoc(version -> "https://javadoc.jetty.org/jetty-%s".formatted(version.major()))
951966
releaseNotes("https://github.com/jetty/jetty.project/releases/tag/jetty-{version}")
952967
}
953968
}
@@ -1149,6 +1164,7 @@ bom {
11491164
}
11501165
links {
11511166
site("https://www.liquibase.com")
1167+
javadoc("https://javadoc.io/doc/org.liquibase/liquibase-core/{version}")
11521168
releaseNotes("https://github.com/liquibase/liquibase/releases/tag/v{version}")
11531169
}
11541170
}
@@ -1160,6 +1176,8 @@ bom {
11601176
}
11611177
links {
11621178
site("https://logging.apache.org/log4j")
1179+
javadoc("log4j-api", version -> "https://logging.apache.org/log4j/%s.x/javadoc/log4j-api/index.html".formatted(version.major()))
1180+
javadoc("log4j-core", version -> "https://logging.apache.org/log4j/%s.x/javadoc/log4j-core/index.html".formatted(version.major()))
11631181
docs(version -> "https://logging.apache.org/log4j/%s.x/manual".formatted(version.major()))
11641182
releaseNotes("https://github.com/apache/logging-log4j2/releases/tag/rel%2F{version}")
11651183
}
@@ -1173,6 +1191,7 @@ bom {
11731191
}
11741192
links {
11751193
site("https://logback.qos.ch")
1194+
javadoc("https://logback.qos.ch/apidocs")
11761195
}
11771196
}
11781197
library("Lombok", "1.18.34") {
@@ -1183,6 +1202,7 @@ bom {
11831202
}
11841203
links {
11851204
site("https://projectlombok.org")
1205+
javadoc("https://projectlombok.org/api/")
11861206
}
11871207
}
11881208
library("MariaDB", "3.3.3") {
@@ -2335,6 +2355,8 @@ bom {
23352355
}
23362356
links {
23372357
site("https://www.thymeleaf.org/")
2358+
javadoc("thymeleaf", version -> "https://www.thymeleaf.org/apidocs/thymeleaf/%s".formatted(version), "org.thymeleaf")
2359+
javadoc("thymeleaf-spring6", version -> "https://www.thymeleaf.org/apidocs/thymeleaf-spring6/%s".formatted(version), "org.thymeleaf.spring6")
23382360
releaseNotes("https://github.com/thymeleaf/thymeleaf/releases/tag/thymeleaf-{version}")
23392361
}
23402362
}
@@ -2380,9 +2402,9 @@ bom {
23802402
}
23812403
links {
23822404
site("https://tomcat.apache.org")
2405+
javadoc(version -> "https://tomcat.apache.org/tomcat-%s.%s-doc/api".formatted(version.major(), version.minor()))
23832406
docs(version -> "https://tomcat.apache.org/tomcat-%s.%s-doc".formatted(version.major(), version.minor()))
2384-
releaseNotes(version -> "https://tomcat.apache.org/tomcat-%s.%s-doc/changelog.html"
2385-
.formatted(version.major(), version.minor()))
2407+
releaseNotes(version -> "https://tomcat.apache.org/tomcat-%s.%s-doc/changelog.html".formatted(version.major(), version.minor()))
23862408
}
23872409
}
23882410
library("UnboundID LDAPSDK", "6.0.11") {

0 commit comments

Comments
 (0)