diff --git a/framework-api/framework-api.gradle b/framework-api/framework-api.gradle index e4919ed34c..b39133c5c8 100644 --- a/framework-api/framework-api.gradle +++ b/framework-api/framework-api.gradle @@ -27,7 +27,8 @@ javadoc { author = true header = rootProject.description use = true - overview = "framework-docs/src/docs/api/overview.html" + overview = "$rootProject.rootDir/framework-docs/src/docs/api/overview.html" + destinationDir = file("${project.buildDir}/docs/javadoc-api") splitIndex = true links(rootProject.ext.javadocLinks) addBooleanOption('Xdoclint:syntax,reference', true) // only check syntax and reference with doclint @@ -51,7 +52,8 @@ rootProject.tasks.dokkaHtmlMultiModule.configure { tasks.named("javadoc") } moduleName.set("spring-framework") - outputDirectory.set(project.file("$buildDir/docs/kdoc")) + outputDirectory.set(project.file("$buildDir/docs/kdoc-api")) + includes.from("$rootProject.rootDir/framework-docs/src/docs/api/dokka-overview.md") } /** diff --git a/framework-docs/src/docs/api/dokka-overview.md b/framework-docs/src/docs/api/dokka-overview.md new file mode 100644 index 0000000000..e68dd557ff --- /dev/null +++ b/framework-docs/src/docs/api/dokka-overview.md @@ -0,0 +1,2 @@ +# All Modules +_See also the Java API documentation (Javadoc)._ \ No newline at end of file diff --git a/framework-docs/src/docs/api/overview.html b/framework-docs/src/docs/api/overview.html index e6086dc458..6e98d58b9c 100644 --- a/framework-docs/src/docs/api/overview.html +++ b/framework-docs/src/docs/api/overview.html @@ -1,7 +1,10 @@

-This is the public API documentation for the Spring Framework. +This is the public Java API documentation (Javadoc) for the Spring Framework.

+

+See also the Kotlin API documentation (KDoc). +