Skip to content

Commit a3b027a

Browse files
philwebbphilwebb
committed
Add more javadoc links
See gh-41614
1 parent 5639c25 commit a3b027a

File tree

4 files changed

+126
-8
lines changed

4 files changed

+126
-8
lines changed

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

+32-1
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,26 @@ private void addVersionAttributes(Map<String, String> attributes, Map<String, St
141141
addSpringDataDependencyVersion(attributes, internal, "spring-data-redis");
142142
addSpringDataDependencyVersion(attributes, internal, "spring-data-rest", "spring-data-rest-core");
143143
addSpringDataDependencyVersion(attributes, internal, "spring-data-ldap");
144+
addTestcontainersDependencyVersion(attributes, internal, "activemq");
145+
addTestcontainersDependencyVersion(attributes, internal, "cassandra");
146+
addTestcontainersDependencyVersion(attributes, internal, "couchbase");
147+
addTestcontainersDependencyVersion(attributes, internal, "elasticsearch");
148+
addTestcontainersDependencyVersion(attributes, internal, "jdbc");
149+
addTestcontainersDependencyVersion(attributes, internal, "kafka");
150+
addTestcontainersDependencyVersion(attributes, internal, "mariadb");
151+
addTestcontainersDependencyVersion(attributes, internal, "mongodb");
152+
addTestcontainersDependencyVersion(attributes, internal, "mssqlserver");
153+
addTestcontainersDependencyVersion(attributes, internal, "mysql");
154+
addTestcontainersDependencyVersion(attributes, internal, "neo4j");
155+
addTestcontainersDependencyVersion(attributes, internal, "oracle-xe");
156+
addTestcontainersDependencyVersion(attributes, internal, "oracle-free");
157+
addTestcontainersDependencyVersion(attributes, internal, "postgresql");
158+
addTestcontainersDependencyVersion(attributes, internal, "pulsar");
159+
addTestcontainersDependencyVersion(attributes, internal, "rabbitmq");
160+
addTestcontainersDependencyVersion(attributes, internal, "redpanda");
161+
addTestcontainersDependencyVersion(attributes, internal, "r2dbc");
162+
addDependencyVersion(attributes, "pulsar-client-reactive-api", "org.apache.pulsar:pulsar-client-reactive-api");
163+
addDependencyVersion(attributes, "pulsar-client-api", "org.apache.pulsar:pulsar-client-api");
144164
}
145165

146166
private void addSpringDataDependencyVersion(Map<String, String> attributes, Map<String, String> internal,
@@ -159,6 +179,11 @@ private void addSpringDataDependencyVersion(Map<String, String> attributes, Map<
159179
internal.put("dotxversion-" + name, majorMinor + ".x");
160180
}
161181

182+
private void addTestcontainersDependencyVersion(Map<String, String> attributes, Map<String, String> internal,
183+
String artifactId) {
184+
addDependencyVersion(attributes, "testcontainers-" + artifactId, "org.testcontainers:" + artifactId);
185+
}
186+
162187
private void addDependencyVersion(Map<String, String> attributes, String name, String groupAndArtifactId) {
163188
attributes.put("version-" + name, getVersion(groupAndArtifactId));
164189
}
@@ -178,9 +203,15 @@ private void addArtifactAttributes(Map<String, String> attributes) {
178203

179204
private void addUrlJava(Map<String, String> attributes) {
180205
attributes.put("url-javase-javadoc", "https://docs.oracle.com/en/java/javase/17/docs/api/");
181-
attributes.put("javadoc-location-java-util", "{url-javase-javadoc}");
206+
attributes.put("javadoc-location-java-beans", "{url-javase-javadoc}");
182207
attributes.put("javadoc-location-java-lang", "{url-javase-javadoc}");
208+
attributes.put("javadoc-location-java-net", "{url-javase-javadoc}");
209+
attributes.put("javadoc-location-java-io", "{url-javase-javadoc}");
210+
attributes.put("javadoc-location-java-time", "{url-javase-javadoc}");
211+
attributes.put("javadoc-location-java-util", "{url-javase-javadoc}");
183212
attributes.put("javadoc-location-javax-management", "{url-javase-javadoc}");
213+
attributes.put("javadoc-location-javax-net", "{url-javase-javadoc}");
214+
attributes.put("javadoc-location-javax-sql", "{url-javase-javadoc}");
184215
attributes.put("javadoc-location-javax-xml", "{url-javase-javadoc}");
185216
}
186217

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

+22
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ url-native-build-tools-docs-gradle-plugin={url-native-build-tools-docs}/gradle-p
3333
url-native-build-tools-docs-maven-plugin={url-native-build-tools-docs}/maven-plugin.html
3434
url-paketo-docs=https://paketo.io/docs
3535
url-paketo-docs-java-buildpack={url-paketo-docs}/buildpacks/language-family-buildpacks/java
36+
url-pulsar-client-api-javadoc=https://javadoc.io/doc/org.apache.pulsar/pulsar-client-api/{version-pulsar-client-api}
37+
url-pulsar-client-reactive-api-javadoc=https://javadoc.io/doc/org.apache.pulsar/pulsar-client-reactive-api/{version-pulsar-client-reactive-api}
3638
url-spring-boot-for-apache-geode-docs=https://docs.spring.io/spring-boot-data-geode-build/2.0.x/reference/html5
3739
url-spring-boot-for-apache-geode-site=https://github.com/spring-projects/spring-boot-data-geode
3840
url-spring-data-cassandra-docs=https://docs.spring.io/spring-data/cassandra/reference/{antoraversion-spring-data-cassandra}
@@ -72,13 +74,33 @@ url-spring-data-rest-docs=https://docs.spring.io/spring-data/rest/reference/{ant
7274
url-spring-data-rest-site=https://spring.io/projects/spring-data-rest
7375
url-spring-data-rest-javadoc=https://docs.spring.io/spring-data/rest/docs/{dotxversion-spring-data-rest}/api
7476
url-spring-data-site=https://spring.io/projects/spring-data
77+
url-testcontainers-activemq-javadoc=https://javadoc.io/doc/org.testcontainers/activemq/{version-testcontainers-activemq}
78+
url-testcontainers-cassandra-javadoc=https://javadoc.io/doc/org.testcontainers/cassandra/{version-testcontainers-cassandra}
79+
url-testcontainers-couchbase-javadoc=https://javadoc.io/doc/org.testcontainers/couchbase/{version-testcontainers-couchbase}
80+
url-testcontainers-elasticsearch-javadoc=https://javadoc.io/doc/org.testcontainers/elasticsearch/{version-testcontainers-elasticsearch}
81+
url-testcontainers-jdbc-javadoc=https://javadoc.io/doc/org.testcontainers/jdbc/{version-testcontainers-jdbc}
82+
url-testcontainers-kafka-javadoc=https://javadoc.io/doc/org.testcontainers/kafka/{version-testcontainers-kafka}
83+
url-testcontainers-mariadb-javadoc=https://javadoc.io/doc/org.testcontainers/mariadb/{version-testcontainers-mariadb}
84+
url-testcontainers-mongodb-javadoc=https://javadoc.io/doc/org.testcontainers/mongodb/{version-testcontainers-mongodb}
85+
url-testcontainers-mssqlserver-javadoc=https://javadoc.io/doc/org.testcontainers/mssqlserver/{version-testcontainers-mssqlserver}
86+
url-testcontainers-mysql-javadoc=https://javadoc.io/doc/org.testcontainers/mysql/{version-testcontainers-mysql}
87+
url-testcontainers-neo4j-javadoc=https://javadoc.io/doc/org.testcontainers/neo4j/{version-testcontainers-neo4j}
88+
url-testcontainers-oracle-xe-javadoc=https://javadoc.io/doc/org.testcontainers/oracle-xe/{version-testcontainers-oracle-xe}
89+
url-testcontainers-oracle-free-javadoc=https://javadoc.io/doc/org.testcontainers/oracle-free/{version-testcontainers-oracle-free}
90+
url-testcontainers-postgresql-javadoc=https://javadoc.io/doc/org.testcontainers/postgresql/{version-testcontainers-postgresql}
91+
url-testcontainers-pulsar-javadoc=https://javadoc.io/doc/org.testcontainers/pulsar/{version-testcontainers-pulsar}
92+
url-testcontainers-rabbitmq-javadoc=https://javadoc.io/doc/org.testcontainers/rabbitmq/{version-testcontainers-rabbitmq}
93+
url-testcontainers-redpanda-javadoc=https://javadoc.io/doc/org.testcontainers/redpanda/{version-testcontainers-redpanda}
94+
url-testcontainers-r2dbc-javadoc=https://javadoc.io/doc/org.testcontainers/r2dbc/{version-testcontainers-r2dbc}
7595
url-jackson-annotations-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-annotations/{version-jackson-annotations}
7696
url-jackson-core-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-core/{version-jackson-core}
7797
url-jackson-databind-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-databind/{version-jackson-databind}
7898
url-jackson-dataformat-xml-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/{version-jackson-dataformat-xml}
7999

80100
# === Javadoc Locations ===
81101

102+
javadoc-location-org-apache-pulsar-client-api={url-pulsar-client-api-javadoc}
103+
javadoc-location-org-apache-pulsar-reactive-client-api={url-pulsar-client-reactive-api-javadoc}
82104
javadoc-location-org-springframework-data-cassandra={url-spring-data-cassandra-javadoc}
83105
javadoc-location-org-springframework-data-querydsl={url-spring-data-commons-javadoc}
84106
javadoc-location-org-springframework-data-repository={url-spring-data-commons-javadoc}

‎buildSrc/src/test/java/org/springframework/boot/build/antora/AntoraAsciidocAttributesTests.java

+24
Original file line numberDiff line numberDiff line change
@@ -260,9 +260,29 @@ private Map<String, String> mockDependencyVersions(String version) {
260260
addMockSpringDataVersion(versions, "spring-data-redis", version);
261261
addMockSpringDataVersion(versions, "spring-data-rest-core", version);
262262
addMockSpringDataVersion(versions, "spring-data-ldap", version);
263+
addMockTestcontainersVersion(versions, "activemq", version);
264+
addMockTestcontainersVersion(versions, "cassandra", version);
265+
addMockTestcontainersVersion(versions, "couchbase", version);
266+
addMockTestcontainersVersion(versions, "elasticsearch", version);
267+
addMockTestcontainersVersion(versions, "jdbc", version);
268+
addMockTestcontainersVersion(versions, "kafka", version);
269+
addMockTestcontainersVersion(versions, "mariadb", version);
270+
addMockTestcontainersVersion(versions, "mongodb", version);
271+
addMockTestcontainersVersion(versions, "mssqlserver", version);
272+
addMockTestcontainersVersion(versions, "mysql", version);
273+
addMockTestcontainersVersion(versions, "neo4j", version);
274+
addMockTestcontainersVersion(versions, "oracle-xe", version);
275+
addMockTestcontainersVersion(versions, "oracle-free", version);
276+
addMockTestcontainersVersion(versions, "postgresql", version);
277+
addMockTestcontainersVersion(versions, "pulsar", version);
278+
addMockTestcontainersVersion(versions, "rabbitmq", version);
279+
addMockTestcontainersVersion(versions, "redpanda", version);
280+
addMockTestcontainersVersion(versions, "r2dbc", version);
263281
addMockJacksonCoreVersion(versions, "jackson-annotations", version);
264282
addMockJacksonCoreVersion(versions, "jackson-core", version);
265283
addMockJacksonCoreVersion(versions, "jackson-databind", version);
284+
versions.put("org.apache.pulsar:pulsar-client-api", version);
285+
versions.put("org.apache.pulsar:pulsar-client-reactive-api", version);
266286
versions.put("com.fasterxml.jackson.dataformat:jackson-dataformat-xml", version);
267287
return versions;
268288
}
@@ -271,6 +291,10 @@ private void addMockSpringDataVersion(Map<String, String> versions, String artif
271291
versions.put("org.springframework.data:" + artifactId, version);
272292
}
273293

294+
private void addMockTestcontainersVersion(Map<String, String> versions, String artifactId, String version) {
295+
versions.put("org.testcontainers:" + artifactId, version);
296+
}
297+
274298
private void addMockJacksonCoreVersion(Map<String, String> versions, String artifactId, String version) {
275299
versions.put("com.fasterxml.jackson.core:" + artifactId, version);
276300
}

0 commit comments

Comments
 (0)