Skip to content

Commit 571bd59

Browse files
philwebbphilwebb
committed
Fixup and add more javadoc-location attributes
Fix a few errors and add more javadoc-location package attributes for use in `.adoc` files. See gh-41614
1 parent 30efd52 commit 571bd59

File tree

3 files changed

+46
-17
lines changed

3 files changed

+46
-17
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
@@ -136,6 +136,7 @@ private void addVersionAttributes(Map<String, String> attributes, Map<String, St
136136
addSpringDataDependencyVersion(attributes, internal, "spring-data-mongodb");
137137
addSpringDataDependencyVersion(attributes, internal, "spring-data-neo4j");
138138
addSpringDataDependencyVersion(attributes, internal, "spring-data-r2dbc");
139+
addSpringDataDependencyVersion(attributes, internal, "spring-data-redis");
139140
addSpringDataDependencyVersion(attributes, internal, "spring-data-rest", "spring-data-rest-core");
140141
addSpringDataDependencyVersion(attributes, internal, "spring-data-ldap");
141142
}
@@ -175,6 +176,9 @@ private void addArtifactAttributes(Map<String, String> attributes) {
175176

176177
private void addUrlJava(Map<String, String> attributes) {
177178
attributes.put("url-javase-javadoc", "https://docs.oracle.com/en/java/javase/17/docs/api/");
179+
attributes.put("javadoc-location-java", "{url-javase-javadoc}");
180+
attributes.put("javadoc-location-javax.management", "{url-javase-javadoc}");
181+
attributes.put("javadoc-location-javax.xml", "{url-javase-javadoc}");
178182
}
179183

180184
private void addUrlLibraryLinkAttributes(Map<String, String> attributes) {

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

Lines changed: 38 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,38 +35,63 @@ url-paketo-docs=https://paketo.io/docs
3535
url-paketo-docs-java-buildpack={url-paketo-docs}/buildpacks/language-family-buildpacks/java
3636
url-spring-boot-for-apache-geode-docs=https://docs.spring.io/spring-boot-data-geode-build/2.0.x/reference/html5
3737
url-spring-boot-for-apache-geode-site=https://github.com/spring-projects/spring-boot-data-geode
38-
url-spring-data-cassandra-javadoc=https://docs.spring.io/spring-data/cassandra/docs/{dotxversion-spring-data-cassandra}/api
39-
url-spring-data-cassandra-site=https://spring.io/projects/spring-data-cassandra
4038
url-spring-data-cassandra-docs=https://docs.spring.io/spring-data/cassandra/reference/{antoraversion-spring-data-cassandra}
39+
url-spring-data-cassandra-site=https://spring.io/projects/spring-data-cassandra
40+
url-spring-data-cassandra-javadoc=https://docs.spring.io/spring-data/cassandra/docs/{dotxversion-spring-data-cassandra}/api
4141
url-spring-data-commons-javadoc=https://docs.spring.io/spring-data/commons/docs/{dotxversion-spring-data-commons}/api
4242
url-spring-data-couchbase-docs=https://docs.spring.io/spring-data/couchbase/reference/{antoraversion-spring-data-couchbase}
4343
url-spring-data-couchbase-site=https://spring.io/projects/spring-data-couchbase
4444
url-spring-data-couchbase-javadoc=https://docs.spring.io/spring-data/couchbase/docs/{dotxversion-spring-data-couchbase}/api
45-
url-spring-data-elasticsearch-javadoc=https://docs.spring.io/spring-data/elasticsearch/docs/{dotxversion-spring-data-elasticsearch}/api
4645
url-spring-data-elasticsearch-docs=https://docs.spring.io/spring-data/elasticsearch/reference/{antoraversion-spring-data-elasticsearch}
4746
url-spring-data-elasticsearch-site=https://spring.io/projects/spring-data-elasticsearch
47+
url-spring-data-elasticsearch-javadoc=https://docs.spring.io/spring-data/elasticsearch/docs/{dotxversion-spring-data-elasticsearch}/api
4848
url-spring-data-envers-site=https://spring.io/projects/spring-data-envers
4949
url-spring-data-geode-site=https://spring.io/projects/spring-data-geode
5050
url-spring-data-jdbc-docs=https://docs.spring.io/spring-data/relational/reference/{antoraversion-spring-data-jdbc}
51-
url-spring-data-jpa-javadoc=https://docs.spring.io/spring-data/jpa/docs/{dotxversion-spring-data-jpa}/api
52-
url-spring-data-jpa-site=https://spring.io/projects/spring-data-jpa
51+
url-spring-data-jdbc-site=https://spring.io/projects/spring-data-jdbc
52+
url-spring-data-jdbc-javadoc=https://docs.spring.io/spring-data/jdbc/docs/{dotxversion-spring-data-jdbc}/api
5353
url-spring-data-jpa-docs=https://docs.spring.io/spring-data/jpa/reference/{antoraversion-spring-data-jpa}
54-
url-spring-data-ldap-site=https://spring.io/projects/spring-data-ldap
54+
url-spring-data-jpa-site=https://spring.io/projects/spring-data-jpa
55+
url-spring-data-jpa-javadoc=https://docs.spring.io/spring-data/jpa/docs/{dotxversion-spring-data-jpa}/api
5556
url-spring-data-ldap-docs=https://docs.spring.io/spring-data/ldap/reference/{antoraversion-spring-data-ldap}
56-
url-spring-data-mongodb-javadoc=https://docs.spring.io/spring-data/mongodb/docs/{dotxversion-spring-data-mongodb}/api
57-
url-spring-data-mongodb-site=https://spring.io/projects/spring-data-mongodb
57+
url-spring-data-ldap-site=https://spring.io/projects/spring-data-ldap
58+
url-spring-data-ldap-javadoc=https://docs.spring.io/spring-data/ldap/docs/{dotxversion-spring-data-ldap}/api
5859
url-spring-data-mongodb-docs=https://docs.spring.io/spring-data/mongodb/reference/{antoraversion-spring-data-mongodb}
59-
url-spring-data-neo4j-javadoc=https://docs.spring.io/spring-data/neo4j/docs/{dotxversion-spring-data-neo4j}/api
60+
url-spring-data-mongodb-site=https://spring.io/projects/spring-data-mongodb
61+
url-spring-data-mongodb-javadoc=https://docs.spring.io/spring-data/mongodb/docs/{dotxversion-spring-data-mongodb}/api
6062
url-spring-data-neo4j-docs=https://docs.spring.io/spring-data/neo4j/reference/{antoraversion-spring-data-neo4j}
6163
url-spring-data-neo4j-site=https://spring.io/projects/spring-data-neo4j
62-
url-spring-data-r2dbc-javadoc=https://docs.spring.io/spring-data/r2dbc/docs/{dotxversion-spring-data-r2dbc}/api
64+
url-spring-data-neo4j-javadoc=https://docs.spring.io/spring-data/neo4j/docs/{dotxversion-spring-data-neo4j}/api
6365
url-spring-data-r2dbc-docs=https://docs.spring.io/spring-data/relational/reference/{antoraversion-spring-data-r2dbc}
66+
url-spring-data-r2dbc-site=https://spring.io/projects/spring-data-r2dbc
67+
url-spring-data-r2dbc-javadoc=https://docs.spring.io/spring-data/r2dbc/docs/{dotxversion-spring-data-r2dbc}/api
68+
url-spring-data-redis-docs=https://docs.spring.io/spring-data/redis/reference/{antoraversion-spring-data-redis}
6469
url-spring-data-redis-site=https://spring.io/projects/spring-data-redis
70+
url-spring-data-redis-javadoc=https://docs.spring.io/spring-data/redis/docs/{dotxversion-spring-data-redis}/api
71+
url-spring-data-rest-docs=https://docs.spring.io/spring-data/rest/reference/{antoraversion-spring-data-rest}
72+
url-spring-data-rest-site=https://spring.io/projects/spring-data-rest
6573
url-spring-data-rest-javadoc=https://docs.spring.io/spring-data/rest/docs/{dotxversion-spring-data-rest}/api
6674
url-spring-data-site=https://spring.io/projects/spring-data
67-
url-jackson-annotations=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-annotations/{version-jackson-annotations}
68-
url-jackson-core=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-core/{version-jackson-core}
69-
url-jackson-databind=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-databind/{version-jackson-databind}
75+
url-jackson-annotations-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-annotations/{version-jackson-annotations}
76+
url-jackson-core-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-core/{version-jackson-core}
77+
url-jackson-databind-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-databind/{version-jackson-databind}
78+
79+
# === Javadoc Locations ===
80+
81+
javadoc-location-org-springframework-data-cassandra={url-spring-data-cassandra-javadoc}
82+
javadoc-location-org-springframework-data-querydsl={url-spring-data-commons-javadoc}
83+
javadoc-location-org-springframework-data-repository={url-spring-data-commons-javadoc}
84+
javadoc-location-org-springframework-data-couchbase={url-spring-data-couchbase-javadoc}
85+
javadoc-location-org-springframework-data-elasticsearch={url-spring-data-elasticsearch-javadoc}
86+
javadoc-location-org-springframework-data-jdbc={url-spring-data-jdbc-javadoc}
87+
javadoc-location-org-springframework-data-jpa={url-spring-data-jpa-javadoc}
88+
javadoc-location-org-springframework-data-ldap={url-spring-data-ldap-javadoc}
89+
javadoc-location-org-springframework-data-mongodb={url-spring-data-mongodb-javadoc}
90+
javadoc-location-org-springframework-data-neo4j={url-spring-data-neo4j-javadoc}
91+
javadoc-location-org-springframework-data-r2dbc={url-spring-data-r2dbc-javadoc}
92+
javadoc-location-org-springframework-data-redis={url-spring-data-redis-javadoc}
93+
javadoc-location-org-springframework-data-rest={url-spring-data-rest-javadoc}
94+
javadoc-location-com-fasterxml-jackson-databind={url-jackson-databind-javadoc}
7095

7196
# === API References ===
7297

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -529,7 +529,7 @@ bom {
529529
links {
530530
site("https://hibernate.org/orm")
531531
javadoc(version -> "https://docs.jboss.org/hibernate/orm/%s.%s/javadocs"
532-
.formatted(version.major(), version.minor()))
532+
.formatted(version.major(), version.minor()), "org.hibernate.boot", "org.hibernate.resource")
533533
docs(version -> "https://hibernate.org/orm/documentation/%s.%s"
534534
.formatted(version.major(), version.minor()))
535535
releaseNotes(version -> "https://github.com/hibernate/hibernate-orm/releases/tag/%s"
@@ -1693,7 +1693,7 @@ bom {
16931693
}
16941694
links {
16951695
site("https://github.com/quartz-scheduler/quartz")
1696-
javadoc("https://www.javadoc.io/doc/org.quartz-scheduler/quartz/{version}", "org.quartz")
1696+
javadoc("https://javadoc.io/doc/org.quartz-scheduler/quartz/{version}", "org.quartz")
16971697
releaseNotes("https://github.com/quartz-scheduler/quartz/releases/tag/v{version}")
16981698
}
16991699
}
@@ -2038,7 +2038,7 @@ bom {
20382038
site("https://spring.io/projects/spring-amqp")
20392039
github("https://github.com/spring-projects/spring-amqp")
20402040
javadoc(version -> "https://docs.spring.io/spring-amqp/docs/%s/api"
2041-
.formatted(version.forMajorMinorGeneration()), "org.springframework.amqp")
2041+
.formatted(version.forMajorMinorGeneration()), "org.springframework.amqp", "org.springframework.rabbit")
20422042
docs(version -> "https://docs.spring.io/spring-amqp/reference/%s"
20432043
.formatted(version.forAntora()))
20442044
releaseNotes("https://github.com/spring-projects/spring-amqp/releases/tag/v{version}")
@@ -2103,7 +2103,7 @@ bom {
21032103
site("https://spring.io/projects/spring-framework")
21042104
github("https://github.com/spring-projects/spring-framework")
21052105
javadoc(version -> "https://docs.spring.io/spring-framework/docs/%s/javadoc-api"
2106-
.formatted(version.forMajorMinorGeneration()), "org.springframework.[aop|aot|asm|beans|cache|cglib| " +
2106+
.formatted(version.forMajorMinorGeneration()), "org.springframework.[aop|aot|asm|beans|cache|cglib|" +
21072107
"context|core|dao|ejb|expression|format|http|instrument|jca|jdbc|jms|jmx|jndi|lang|mail|" +
21082108
"messaging|mock|objenesis|orm|oxm|r2dbc|scheduling|scripting|stereotype|test|transaction|" +
21092109
"ui|util|validation|web]")

0 commit comments

Comments
 (0)