GitHub-Spring
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Refine javadoc links 

See gh-41614
pull/43333/head
Phillip Webb 1 year ago
parent
dc49c64e56
commit
81ba8b6c7b
3 changed files with 15 additions and 7 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      buildSrc/src/main/java/org/springframework/boot/build/antora/AntoraAsciidocAttributes.java
  2. 1
      buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties
  3. 17
      spring-boot-project/spring-boot-dependencies/build.gradle

4
buildSrc/src/main/java/org/springframework/boot/build/antora/AntoraAsciidocAttributes.java
Unescape View File

@ -207,11 +207,15 @@ public class AntoraAsciidocAttributes {
attributes.put("javadoc-location-java-lang", "{url-javase-javadoc}/java.base"); attributes.put("javadoc-location-java-lang", "{url-javase-javadoc}/java.base");
attributes.put("javadoc-location-java-net", "{url-javase-javadoc}/java.base"); attributes.put("javadoc-location-java-net", "{url-javase-javadoc}/java.base");
attributes.put("javadoc-location-java-io", "{url-javase-javadoc}/java.base"); attributes.put("javadoc-location-java-io", "{url-javase-javadoc}/java.base");
attributes.put("javadoc-location-java-nio", "{url-javase-javadoc}/java.base");
attributes.put("javadoc-location-java-security", "{url-javase-javadoc}/java.base");
attributes.put("javadoc-location-java-sql", "{url-javase-javadoc}/java.sql");
attributes.put("javadoc-location-java-time", "{url-javase-javadoc}/java.base"); attributes.put("javadoc-location-java-time", "{url-javase-javadoc}/java.base");
attributes.put("javadoc-location-java-util", "{url-javase-javadoc}/java.base"); attributes.put("javadoc-location-java-util", "{url-javase-javadoc}/java.base");
attributes.put("javadoc-location-javax-management", "{url-javase-javadoc}/java.management"); attributes.put("javadoc-location-javax-management", "{url-javase-javadoc}/java.management");
attributes.put("javadoc-location-javax-net", "{url-javase-javadoc}/java.base"); attributes.put("javadoc-location-javax-net", "{url-javase-javadoc}/java.base");
attributes.put("javadoc-location-javax-sql", "{url-javase-javadoc}/java.sql"); attributes.put("javadoc-location-javax-sql", "{url-javase-javadoc}/java.sql");
attributes.put("javadoc-location-javax-security", "{url-javase-javadoc}/java.base");
attributes.put("javadoc-location-javax-xml", "{url-javase-javadoc}/java.xml"); attributes.put("javadoc-location-javax-xml", "{url-javase-javadoc}/java.xml");
} }

1
buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties
Unescape View File

@ -102,6 +102,7 @@ url-jackson-dataformat-xml-javadoc=https://javadoc.io/doc/com.fasterxml.jackson.
javadoc-location-org-apache-pulsar-client-api={url-pulsar-client-api-javadoc} javadoc-location-org-apache-pulsar-client-api={url-pulsar-client-api-javadoc}
javadoc-location-org-apache-pulsar-reactive-client-api={url-pulsar-client-reactive-api-javadoc} javadoc-location-org-apache-pulsar-reactive-client-api={url-pulsar-client-reactive-api-javadoc}
javadoc-location-org-springframework-data-cassandra={url-spring-data-cassandra-javadoc} javadoc-location-org-springframework-data-cassandra={url-spring-data-cassandra-javadoc}
javadoc-location-org-springframework-data-convert={url-spring-data-commons-javadoc}
javadoc-location-org-springframework-data-querydsl={url-spring-data-commons-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-repository={url-spring-data-commons-javadoc}
javadoc-location-org-springframework-data-couchbase={url-spring-data-couchbase-javadoc} javadoc-location-org-springframework-data-couchbase={url-spring-data-couchbase-javadoc}

17
spring-boot-project/spring-boot-dependencies/build.gradle
Unescape View File

@ -61,6 +61,7 @@ bom {
} }
links { links {
site("https://activemq.apache.org/components/artemis") site("https://activemq.apache.org/components/artemis")
javadoc("https://javadoc.io/doc/org.apache.activemq/artemis-jms-server/{version}", "org.apache.activemq.artemis.jms.server")
releaseNotes("https://activemq.apache.org/components/artemis/download/release-notes-{version}") releaseNotes("https://activemq.apache.org/components/artemis/download/release-notes-{version}")
} }
} }
@ -176,6 +177,7 @@ bom {
} }
links { links {
site("https://github.com/ben-manes/caffeine") site("https://github.com/ben-manes/caffeine")
javadoc("https://javadoc.io/doc/com.github.ben-manes.caffeine/caffeine/{version}", "com.github.benmanes.caffeine")
docs("https://github.com/ben-manes/caffeine/wiki") docs("https://github.com/ben-manes/caffeine/wiki")
releaseNotes("https://github.com/ben-manes/caffeine/releases/tag/v{version}") releaseNotes("https://github.com/ben-manes/caffeine/releases/tag/v{version}")
} }
@ -448,7 +450,7 @@ bom {
} }
links { links {
site("https://www.graphql-java.com/") site("https://www.graphql-java.com/")
javadoc("https://javadoc.io/doc/com.graphql-java/graphql-java/{version}", "graphql") javadoc("https://javadoc.io/doc/com.graphql-java/graphql-java/{version}", "graphql.schema", "graphql.execution")
releaseNotes("https://github.com/graphql-java/graphql-java/releases/tag/v{version}") releaseNotes("https://github.com/graphql-java/graphql-java/releases/tag/v{version}")
} }
} }
@ -957,6 +959,7 @@ bom {
} }
links { links {
site("https://github.com/eclipse-ee4j/jersey") site("https://github.com/eclipse-ee4j/jersey")
javadoc("https://javadoc.io/doc/org.glassfish.jersey.core/jersey-server/{version}", "org.glassfish.jersey.server")
releaseNotes("https://github.com/eclipse-ee4j/jersey/releases/tag/{version}") releaseNotes("https://github.com/eclipse-ee4j/jersey/releases/tag/{version}")
} }
} }
@ -980,7 +983,7 @@ bom {
} }
links { links {
site("https://eclipse.dev/jetty") site("https://eclipse.dev/jetty")
javadoc(version -> "https://javadoc.jetty.org/jetty-%s".formatted(version.major())) javadoc(version -> "https://javadoc.jetty.org/jetty-%s".formatted(version.major()), "org.eclipse.jetty")
releaseNotes("https://github.com/jetty/jetty.project/releases/tag/jetty-{version}") releaseNotes("https://github.com/jetty/jetty.project/releases/tag/jetty-{version}")
} }
} }
@ -1197,8 +1200,8 @@ bom {
} }
links { links {
site("https://logging.apache.org/log4j") site("https://logging.apache.org/log4j")
javadoc("log4j-api", version -> "https://logging.apache.org/log4j/%s.x/javadoc/log4j-api/index.html".formatted(version.major())) javadoc("log4j-api", version -> "https://logging.apache.org/log4j/%s.x/javadoc/log4j-api".formatted(version.major()))
javadoc("log4j-core", version -> "https://logging.apache.org/log4j/%s.x/javadoc/log4j-core/index.html".formatted(version.major())) javadoc("log4j-core", version -> "https://logging.apache.org/log4j/%s.x/javadoc/log4j-core".formatted(version.major()), "org.apache.logging.log4j.core")
docs(version -> "https://logging.apache.org/log4j/%s.x/manual".formatted(version.major())) docs(version -> "https://logging.apache.org/log4j/%s.x/manual".formatted(version.major()))
releaseNotes("https://github.com/apache/logging-log4j2/releases/tag/rel%2F{version}") releaseNotes("https://github.com/apache/logging-log4j2/releases/tag/rel%2F{version}")
} }
@ -1212,7 +1215,7 @@ bom {
} }
links { links {
site("https://logback.qos.ch") site("https://logback.qos.ch")
javadoc("https://logback.qos.ch/apidocs") javadoc("https://logback.qos.ch/apidocs", "ch.qos.logback")
} }
} }
library("Lombok", "1.18.36") { library("Lombok", "1.18.36") {
@ -1586,7 +1589,7 @@ bom {
site("https://github.com/open-telemetry/opentelemetry-java") site("https://github.com/open-telemetry/opentelemetry-java")
javadoc("opentelemetry-api", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-api/%s".formatted(version), "io.opentelemetry.api") javadoc("opentelemetry-api", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-api/%s".formatted(version), "io.opentelemetry.api")
javadoc("opentelemetry-context", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-context/%s".formatted(version), "io.opentelemetry.context") javadoc("opentelemetry-context", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-context/%s".formatted(version), "io.opentelemetry.context")
javadoc("opentelemetry-sdk-common", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-common/%s".formatted(version), "io.opentelemetry.sdk.common") 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")
javadoc("opentelemetry-sdk-logs", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-logs/%s".formatted(version), "io.opentelemetry.sdk.logs") javadoc("opentelemetry-sdk-logs", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-logs/%s".formatted(version), "io.opentelemetry.sdk.logs")
javadoc("opentelemetry-sdk-metrics", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-metrics/%s".formatted(version), "io.opentelemetry.sdk.metrics") javadoc("opentelemetry-sdk-metrics", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-metrics/%s".formatted(version), "io.opentelemetry.sdk.metrics")
javadoc("opentelemetry-sdk-trace", version -> "https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-trace/%s".formatted(version), "io.opentelemetry.sdk.trace") 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 {
} }
links { links {
site("https://tomcat.apache.org") site("https://tomcat.apache.org")
javadoc(version -> "https://tomcat.apache.org/tomcat-%s.%s-doc/api".formatted(version.major(), version.minor()), "org.apache.catalina") javadoc(version -> "https://tomcat.apache.org/tomcat-%s.%s-doc/api".formatted(version.major(), version.minor()), "org.apache.catalina", "org.apache.tomcat")
docs(version -> "https://tomcat.apache.org/tomcat-%s.%s-doc".formatted(version.major(), version.minor())) docs(version -> "https://tomcat.apache.org/tomcat-%s.%s-doc".formatted(version.major(), version.minor()))
releaseNotes(version -> "https://tomcat.apache.org/tomcat-%s.%s-doc/changelog.html".formatted(version.major(), version.minor())) releaseNotes(version -> "https://tomcat.apache.org/tomcat-%s.%s-doc/changelog.html".formatted(version.major(), version.minor()))
} }

Write Preview
Loading…
Cancel
Save