From 571bd592fb3bd2068b1f28b5656bac12007f6db8 Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Fri, 8 Nov 2024 21:25:15 -0800 Subject: [PATCH] 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 --- .../antora/AntoraAsciidocAttributes.java | 4 ++ .../antora-asciidoc-attributes.properties | 51 ++++++++++++++----- .../spring-boot-dependencies/build.gradle | 8 +-- 3 files changed, 46 insertions(+), 17 deletions(-) diff --git a/buildSrc/src/main/java/org/springframework/boot/build/antora/AntoraAsciidocAttributes.java b/buildSrc/src/main/java/org/springframework/boot/build/antora/AntoraAsciidocAttributes.java index 17c8c2a1ae..7009e6bea4 100644 --- a/buildSrc/src/main/java/org/springframework/boot/build/antora/AntoraAsciidocAttributes.java +++ b/buildSrc/src/main/java/org/springframework/boot/build/antora/AntoraAsciidocAttributes.java @@ -136,6 +136,7 @@ public class AntoraAsciidocAttributes { addSpringDataDependencyVersion(attributes, internal, "spring-data-mongodb"); addSpringDataDependencyVersion(attributes, internal, "spring-data-neo4j"); addSpringDataDependencyVersion(attributes, internal, "spring-data-r2dbc"); + addSpringDataDependencyVersion(attributes, internal, "spring-data-redis"); addSpringDataDependencyVersion(attributes, internal, "spring-data-rest", "spring-data-rest-core"); addSpringDataDependencyVersion(attributes, internal, "spring-data-ldap"); } @@ -175,6 +176,9 @@ public class AntoraAsciidocAttributes { private void addUrlJava(Map attributes) { attributes.put("url-javase-javadoc", "https://docs.oracle.com/en/java/javase/17/docs/api/"); + attributes.put("javadoc-location-java", "{url-javase-javadoc}"); + attributes.put("javadoc-location-javax.management", "{url-javase-javadoc}"); + attributes.put("javadoc-location-javax.xml", "{url-javase-javadoc}"); } private void addUrlLibraryLinkAttributes(Map attributes) { diff --git a/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties b/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties index 043619c2e8..5bfbb3ec56 100644 --- a/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties +++ b/buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties @@ -35,38 +35,63 @@ url-paketo-docs=https://paketo.io/docs url-paketo-docs-java-buildpack={url-paketo-docs}/buildpacks/language-family-buildpacks/java url-spring-boot-for-apache-geode-docs=https://docs.spring.io/spring-boot-data-geode-build/2.0.x/reference/html5 url-spring-boot-for-apache-geode-site=https://github.com/spring-projects/spring-boot-data-geode -url-spring-data-cassandra-javadoc=https://docs.spring.io/spring-data/cassandra/docs/{dotxversion-spring-data-cassandra}/api -url-spring-data-cassandra-site=https://spring.io/projects/spring-data-cassandra url-spring-data-cassandra-docs=https://docs.spring.io/spring-data/cassandra/reference/{antoraversion-spring-data-cassandra} +url-spring-data-cassandra-site=https://spring.io/projects/spring-data-cassandra +url-spring-data-cassandra-javadoc=https://docs.spring.io/spring-data/cassandra/docs/{dotxversion-spring-data-cassandra}/api url-spring-data-commons-javadoc=https://docs.spring.io/spring-data/commons/docs/{dotxversion-spring-data-commons}/api url-spring-data-couchbase-docs=https://docs.spring.io/spring-data/couchbase/reference/{antoraversion-spring-data-couchbase} url-spring-data-couchbase-site=https://spring.io/projects/spring-data-couchbase url-spring-data-couchbase-javadoc=https://docs.spring.io/spring-data/couchbase/docs/{dotxversion-spring-data-couchbase}/api -url-spring-data-elasticsearch-javadoc=https://docs.spring.io/spring-data/elasticsearch/docs/{dotxversion-spring-data-elasticsearch}/api url-spring-data-elasticsearch-docs=https://docs.spring.io/spring-data/elasticsearch/reference/{antoraversion-spring-data-elasticsearch} url-spring-data-elasticsearch-site=https://spring.io/projects/spring-data-elasticsearch +url-spring-data-elasticsearch-javadoc=https://docs.spring.io/spring-data/elasticsearch/docs/{dotxversion-spring-data-elasticsearch}/api url-spring-data-envers-site=https://spring.io/projects/spring-data-envers url-spring-data-geode-site=https://spring.io/projects/spring-data-geode url-spring-data-jdbc-docs=https://docs.spring.io/spring-data/relational/reference/{antoraversion-spring-data-jdbc} -url-spring-data-jpa-javadoc=https://docs.spring.io/spring-data/jpa/docs/{dotxversion-spring-data-jpa}/api -url-spring-data-jpa-site=https://spring.io/projects/spring-data-jpa +url-spring-data-jdbc-site=https://spring.io/projects/spring-data-jdbc +url-spring-data-jdbc-javadoc=https://docs.spring.io/spring-data/jdbc/docs/{dotxversion-spring-data-jdbc}/api url-spring-data-jpa-docs=https://docs.spring.io/spring-data/jpa/reference/{antoraversion-spring-data-jpa} -url-spring-data-ldap-site=https://spring.io/projects/spring-data-ldap +url-spring-data-jpa-site=https://spring.io/projects/spring-data-jpa +url-spring-data-jpa-javadoc=https://docs.spring.io/spring-data/jpa/docs/{dotxversion-spring-data-jpa}/api url-spring-data-ldap-docs=https://docs.spring.io/spring-data/ldap/reference/{antoraversion-spring-data-ldap} -url-spring-data-mongodb-javadoc=https://docs.spring.io/spring-data/mongodb/docs/{dotxversion-spring-data-mongodb}/api -url-spring-data-mongodb-site=https://spring.io/projects/spring-data-mongodb +url-spring-data-ldap-site=https://spring.io/projects/spring-data-ldap +url-spring-data-ldap-javadoc=https://docs.spring.io/spring-data/ldap/docs/{dotxversion-spring-data-ldap}/api url-spring-data-mongodb-docs=https://docs.spring.io/spring-data/mongodb/reference/{antoraversion-spring-data-mongodb} -url-spring-data-neo4j-javadoc=https://docs.spring.io/spring-data/neo4j/docs/{dotxversion-spring-data-neo4j}/api +url-spring-data-mongodb-site=https://spring.io/projects/spring-data-mongodb +url-spring-data-mongodb-javadoc=https://docs.spring.io/spring-data/mongodb/docs/{dotxversion-spring-data-mongodb}/api url-spring-data-neo4j-docs=https://docs.spring.io/spring-data/neo4j/reference/{antoraversion-spring-data-neo4j} url-spring-data-neo4j-site=https://spring.io/projects/spring-data-neo4j -url-spring-data-r2dbc-javadoc=https://docs.spring.io/spring-data/r2dbc/docs/{dotxversion-spring-data-r2dbc}/api +url-spring-data-neo4j-javadoc=https://docs.spring.io/spring-data/neo4j/docs/{dotxversion-spring-data-neo4j}/api url-spring-data-r2dbc-docs=https://docs.spring.io/spring-data/relational/reference/{antoraversion-spring-data-r2dbc} +url-spring-data-r2dbc-site=https://spring.io/projects/spring-data-r2dbc +url-spring-data-r2dbc-javadoc=https://docs.spring.io/spring-data/r2dbc/docs/{dotxversion-spring-data-r2dbc}/api +url-spring-data-redis-docs=https://docs.spring.io/spring-data/redis/reference/{antoraversion-spring-data-redis} url-spring-data-redis-site=https://spring.io/projects/spring-data-redis +url-spring-data-redis-javadoc=https://docs.spring.io/spring-data/redis/docs/{dotxversion-spring-data-redis}/api +url-spring-data-rest-docs=https://docs.spring.io/spring-data/rest/reference/{antoraversion-spring-data-rest} +url-spring-data-rest-site=https://spring.io/projects/spring-data-rest url-spring-data-rest-javadoc=https://docs.spring.io/spring-data/rest/docs/{dotxversion-spring-data-rest}/api url-spring-data-site=https://spring.io/projects/spring-data -url-jackson-annotations=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-annotations/{version-jackson-annotations} -url-jackson-core=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-core/{version-jackson-core} -url-jackson-databind=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-databind/{version-jackson-databind} +url-jackson-annotations-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-annotations/{version-jackson-annotations} +url-jackson-core-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-core/{version-jackson-core} +url-jackson-databind-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.core/jackson-databind/{version-jackson-databind} + +# === Javadoc Locations === + +javadoc-location-org-springframework-data-cassandra={url-spring-data-cassandra-javadoc} +javadoc-location-org-springframework-data-querydsl={url-spring-data-commons-javadoc} +javadoc-location-org-springframework-data-repository={url-spring-data-commons-javadoc} +javadoc-location-org-springframework-data-couchbase={url-spring-data-couchbase-javadoc} +javadoc-location-org-springframework-data-elasticsearch={url-spring-data-elasticsearch-javadoc} +javadoc-location-org-springframework-data-jdbc={url-spring-data-jdbc-javadoc} +javadoc-location-org-springframework-data-jpa={url-spring-data-jpa-javadoc} +javadoc-location-org-springframework-data-ldap={url-spring-data-ldap-javadoc} +javadoc-location-org-springframework-data-mongodb={url-spring-data-mongodb-javadoc} +javadoc-location-org-springframework-data-neo4j={url-spring-data-neo4j-javadoc} +javadoc-location-org-springframework-data-r2dbc={url-spring-data-r2dbc-javadoc} +javadoc-location-org-springframework-data-redis={url-spring-data-redis-javadoc} +javadoc-location-org-springframework-data-rest={url-spring-data-rest-javadoc} +javadoc-location-com-fasterxml-jackson-databind={url-jackson-databind-javadoc} # === API References === diff --git a/spring-boot-project/spring-boot-dependencies/build.gradle b/spring-boot-project/spring-boot-dependencies/build.gradle index e6deec8c67..fb4bf574a3 100644 --- a/spring-boot-project/spring-boot-dependencies/build.gradle +++ b/spring-boot-project/spring-boot-dependencies/build.gradle @@ -529,7 +529,7 @@ bom { links { site("https://hibernate.org/orm") javadoc(version -> "https://docs.jboss.org/hibernate/orm/%s.%s/javadocs" - .formatted(version.major(), version.minor())) + .formatted(version.major(), version.minor()), "org.hibernate.boot", "org.hibernate.resource") docs(version -> "https://hibernate.org/orm/documentation/%s.%s" .formatted(version.major(), version.minor())) releaseNotes(version -> "https://github.com/hibernate/hibernate-orm/releases/tag/%s" @@ -1693,7 +1693,7 @@ bom { } links { site("https://github.com/quartz-scheduler/quartz") - javadoc("https://www.javadoc.io/doc/org.quartz-scheduler/quartz/{version}", "org.quartz") + javadoc("https://javadoc.io/doc/org.quartz-scheduler/quartz/{version}", "org.quartz") releaseNotes("https://github.com/quartz-scheduler/quartz/releases/tag/v{version}") } } @@ -2038,7 +2038,7 @@ bom { site("https://spring.io/projects/spring-amqp") github("https://github.com/spring-projects/spring-amqp") javadoc(version -> "https://docs.spring.io/spring-amqp/docs/%s/api" - .formatted(version.forMajorMinorGeneration()), "org.springframework.amqp") + .formatted(version.forMajorMinorGeneration()), "org.springframework.amqp", "org.springframework.rabbit") docs(version -> "https://docs.spring.io/spring-amqp/reference/%s" .formatted(version.forAntora())) releaseNotes("https://github.com/spring-projects/spring-amqp/releases/tag/v{version}") @@ -2103,7 +2103,7 @@ bom { site("https://spring.io/projects/spring-framework") github("https://github.com/spring-projects/spring-framework") javadoc(version -> "https://docs.spring.io/spring-framework/docs/%s/javadoc-api" - .formatted(version.forMajorMinorGeneration()), "org.springframework.[aop|aot|asm|beans|cache|cglib| " + + .formatted(version.forMajorMinorGeneration()), "org.springframework.[aop|aot|asm|beans|cache|cglib|" + "context|core|dao|ejb|expression|format|http|instrument|jca|jdbc|jms|jmx|jndi|lang|mail|" + "messaging|mock|objenesis|orm|oxm|r2dbc|scheduling|scripting|stereotype|test|transaction|" + "ui|util|validation|web]")