Browse Source

Limit Kotlin API docs to Kotlin code

Previously, the Kotlin API docs included Java APIs. This commit
corrects this by suppressing all Dokkatoo source sets other than
main (main in src/main/kotlin, javaMain is src/main/java).

Dokkatoo is sensitive to the order in which plugins are applied. This
commit adapts to the sensitivity by changing the order in which
the Dokatoo and Kotlin JVM plugins are applied. This prevents the
Dokatoo plugin for overwriting the configuration that's applied by
our Kotlin conventions.

Closes gh-47763
pull/47902/head
Andy Wilkinson 2 months ago
parent
commit
d2a349868e
  1. 3
      buildSrc/src/main/java/org/springframework/boot/build/KotlinConventions.java
  2. 2
      spring-boot-project/spring-boot-docs/build.gradle
  3. 2
      spring-boot-project/spring-boot-test/build.gradle
  4. 6
      spring-boot-project/spring-boot/build.gradle

3
buildSrc/src/main/java/org/springframework/boot/build/KotlinConventions.java

@ -97,6 +97,9 @@ class KotlinConventions {
link.getPackageListUrl().set(URI.create(url + "/element-list")); link.getPackageListUrl().set(URI.create(url + "/element-list"));
}); });
} }
else {
sourceSet.getSuppress().set(true);
}
}); });
} }

2
spring-boot-project/spring-boot-docs/build.gradle

@ -17,10 +17,10 @@
import org.springframework.boot.build.docs.ConfigureJavadocLinks import org.springframework.boot.build.docs.ConfigureJavadocLinks
plugins { plugins {
id "org.jetbrains.kotlin.jvm"
id "dev.adamko.dokkatoo-html" id "dev.adamko.dokkatoo-html"
id "java" id "java"
id "org.antora" id "org.antora"
id "org.jetbrains.kotlin.jvm"
id "org.springframework.boot.aggregator" id "org.springframework.boot.aggregator"
id "org.springframework.boot.antora-contributor" id "org.springframework.boot.antora-contributor"
id "org.springframework.boot.antora-dependencies" id "org.springframework.boot.antora-dependencies"

2
spring-boot-project/spring-boot-test/build.gradle

@ -15,9 +15,9 @@
*/ */
plugins { plugins {
id "org.jetbrains.kotlin.jvm"
id "dev.adamko.dokkatoo-html" id "dev.adamko.dokkatoo-html"
id "java-library" id "java-library"
id "org.jetbrains.kotlin.jvm"
id "org.springframework.boot.deployed" id "org.springframework.boot.deployed"
id "org.springframework.boot.optional-dependencies" id "org.springframework.boot.optional-dependencies"
} }

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

@ -15,13 +15,13 @@
*/ */
plugins { plugins {
id "dev.adamko.dokkatoo-html"
id "java-library"
id "java-test-fixtures"
id "org.jetbrains.kotlin.jvm" id "org.jetbrains.kotlin.jvm"
id "dev.adamko.dokkatoo-html"
id "org.springframework.boot.configuration-properties" id "org.springframework.boot.configuration-properties"
id "org.springframework.boot.deployed" id "org.springframework.boot.deployed"
id "org.springframework.boot.optional-dependencies" id "org.springframework.boot.optional-dependencies"
id "java-library"
id "java-test-fixtures"
} }
description = "Spring Boot" description = "Spring Boot"

Loading…
Cancel
Save