Browse Source

Migrate from Dokkatoo to Dokka

This commit migrates from Dokkatoo to Dokka for generation of Kotlin
API documentation.

See gh-47706

Signed-off-by: Varun Patni <varun.patni1@gmail.com>
pull/47784/head
Varun Patni 2 months ago committed by Andy Wilkinson
parent
commit
f84b17c751
  1. 3
      buildSrc/build.gradle
  2. 2
      buildSrc/src/main/java/org/springframework/boot/build/JavaConventions.java
  3. 13
      buildSrc/src/main/java/org/springframework/boot/build/KotlinConventions.java
  4. 2
      core/spring-boot/build.gradle
  5. 16
      documentation/spring-boot-docs/build.gradle
  6. 0
      documentation/spring-boot-docs/src/docs/dokka/dokka-overview.md
  7. 2
      module/spring-boot-resttestclient/build.gradle

3
buildSrc/build.gradle

@ -19,6 +19,7 @@ plugins { @@ -19,6 +19,7 @@ plugins {
id "io.spring.javaformat" version "${javaFormatVersion}"
id "checkstyle"
id "eclipse"
id "org.jetbrains.dokka" version "2.1.0"
}
repositories {
@ -51,7 +52,7 @@ dependencies { @@ -51,7 +52,7 @@ dependencies {
implementation("com.tngtech.archunit:archunit:1.4.1")
implementation("commons-codec:commons-codec:${commonsCodecVersion}")
implementation("de.undercouch.download:de.undercouch.download.gradle.plugin:5.5.0")
implementation("dev.adamko.dokkatoo:dokkatoo-plugin:2.3.1")
implementation("org.jetbrains.dokka:dokka-gradle-plugin:2.1.0")
implementation("dev.detekt:detekt-gradle-plugin:2.0.0-alpha.0")
implementation("io.spring.gradle.antora:spring-antora-plugin:0.0.1")
implementation("io.spring.javaformat:spring-javaformat-gradle-plugin:${javaFormatVersion}")

2
buildSrc/src/main/java/org/springframework/boot/build/JavaConventions.java

@ -278,7 +278,7 @@ class JavaConventions { @@ -278,7 +278,7 @@ class JavaConventions {
configurations
.matching((configuration) -> (configuration.getName().endsWith("Classpath")
|| JavaPlugin.ANNOTATION_PROCESSOR_CONFIGURATION_NAME.equals(configuration.getName()))
&& (!configuration.getName().contains("dokkatoo")))
&& (!configuration.getName().contains("dokka")))
.all((configuration) -> configuration.extendsFrom(dependencyManagement));
Dependency springBootParent = project.getDependencies()
.enforcedPlatform(project.getDependencies()

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

@ -18,14 +18,14 @@ package org.springframework.boot.build; @@ -18,14 +18,14 @@ package org.springframework.boot.build;
import java.net.URI;
import dev.adamko.dokkatoo.DokkatooExtension;
import dev.adamko.dokkatoo.formats.DokkatooHtmlPlugin;
import dev.detekt.gradle.Detekt;
import dev.detekt.gradle.extensions.DetektExtension;
import dev.detekt.gradle.plugin.DetektPlugin;
import org.gradle.api.Project;
import org.gradle.api.tasks.SourceSet;
import org.gradle.api.tasks.SourceSetContainer;
import org.jetbrains.dokka.gradle.DokkaExtension;
import org.jetbrains.dokka.gradle.formats.DokkaHtmlPlugin;
import org.jetbrains.kotlin.gradle.dsl.JvmTarget;
import org.jetbrains.kotlin.gradle.dsl.KotlinJvmCompilerOptions;
import org.jetbrains.kotlin.gradle.dsl.KotlinVersion;
@ -59,7 +59,7 @@ class KotlinConventions { @@ -59,7 +59,7 @@ class KotlinConventions {
void apply(Project project) {
project.getPlugins().withId("org.jetbrains.kotlin.jvm", (plugin) -> {
project.getTasks().withType(KotlinCompile.class, this::configure);
project.getPlugins().withType(DokkatooHtmlPlugin.class, (dokkatooPlugin) -> configureDokkatoo(project));
project.getPlugins().withType(DokkaHtmlPlugin.class, (dokkaPlugin) -> configureDokka(project));
configureDetekt(project);
});
}
@ -74,10 +74,9 @@ class KotlinConventions { @@ -74,10 +74,9 @@ class KotlinConventions {
.addAll("-Xsuppress-version-warnings", "-Xannotation-default-target=param-property");
}
private void configureDokkatoo(Project project) {
DokkatooExtension dokkatoo = project.getExtensions().getByType(DokkatooExtension.class);
dokkatoo.getVersions().getJetbrainsDokka().set("2.1.0");
dokkatoo.getDokkatooSourceSets().configureEach((sourceSet) -> {
private void configureDokka(Project project) {
DokkaExtension dokka = project.getExtensions().getByType(DokkaExtension.class);
dokka.getDokkaSourceSets().configureEach((sourceSet) -> {
if (SourceSet.MAIN_SOURCE_SET_NAME.equals(sourceSet.getName())) {
sourceSet.getSourceRoots().setFrom(project.file("src/main/kotlin"));
sourceSet.getClasspath()

2
core/spring-boot/build.gradle

@ -15,7 +15,7 @@ @@ -15,7 +15,7 @@
*/
plugins {
id "dev.adamko.dokkatoo-html"
id "org.jetbrains.dokka"
id "java-library"
id "java-test-fixtures"
id "org.jetbrains.kotlin.jvm"

16
documentation/spring-boot-docs/build.gradle

@ -21,7 +21,7 @@ import org.springframework.boot.build.docs.ConfigureJavadocLinks @@ -21,7 +21,7 @@ import org.springframework.boot.build.docs.ConfigureJavadocLinks
import org.springframework.boot.build.optional.OptionalDependenciesPlugin
plugins {
id "dev.adamko.dokkatoo-html"
id "org.jetbrains.dokka"
id "java"
id "org.antora"
id "org.jetbrains.kotlin.jvm"
@ -85,8 +85,8 @@ plugins.withType(EclipsePlugin) { @@ -85,8 +85,8 @@ plugins.withType(EclipsePlugin) {
dependencies {
compileOnly("org.hamcrest:hamcrest-core")
dokkatoo(project(path: ":core:spring-boot"))
dokkatoo(project(path: ":module:spring-boot-resttestclient"))
dokka(project(path: ":core:spring-boot"))
dokka(project(path: ":module:spring-boot-resttestclient"))
implementation(project(path: ":cli:spring-boot-cli"))
implementation(project(path: ":core:spring-boot-docker-compose"))
@ -242,7 +242,7 @@ dependencies { @@ -242,7 +242,7 @@ dependencies {
testSlices(project(path: ":core:spring-boot-test-autoconfigure", configuration: "testSliceMetadata"))
}
dokkatoo {
dokka {
moduleName.set("Spring Boot Kotlin API")
}
@ -440,7 +440,7 @@ antoraContributions { @@ -440,7 +440,7 @@ antoraContributions {
from(aggregatedJavadoc) {
into "java"
}
from(tasks.named("dokkatooGeneratePublicationHtml")) {
from(tasks.named("dokkaGeneratePublicationHtml")) {
into "kotlin"
}
}
@ -507,8 +507,8 @@ antoraContributions { @@ -507,8 +507,8 @@ antoraContributions {
}
}
dokkatoo {
dokkatooPublications.configureEach {
includes.from("src/docs/dokkatoo/dokka-overview.md")
dokka {
dokkaPublications.configureEach {
includes.from("src/docs/dokka/dokka-overview.md")
}
}

0
documentation/spring-boot-docs/src/docs/dokkatoo/dokka-overview.md → documentation/spring-boot-docs/src/docs/dokka/dokka-overview.md

2
module/spring-boot-resttestclient/build.gradle

@ -15,7 +15,7 @@ @@ -15,7 +15,7 @@
*/
plugins {
id "dev.adamko.dokkatoo-html"
id "org.jetbrains.dokka"
id "java-library"
id "org.jetbrains.kotlin.jvm"
id "org.springframework.boot.auto-configuration"

Loading…
Cancel
Save