From ac3a2c1245fc3425e1c8c6bff1f8cfb7c8cd1352 Mon Sep 17 00:00:00 2001 From: Gregor Dschung Date: Wed, 12 Jan 2022 00:00:46 +0100 Subject: [PATCH] Add a note about usage in a precompiled script plugin see #2301 --- docs/src/doc/docs/user_guide/gradle/usage.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/src/doc/docs/user_guide/gradle/usage.md b/docs/src/doc/docs/user_guide/gradle/usage.md index 5e2fea37fe..a192f54cb3 100644 --- a/docs/src/doc/docs/user_guide/gradle/usage.md +++ b/docs/src/doc/docs/user_guide/gradle/usage.md @@ -60,6 +60,14 @@ tasks.named("dokkaHtml") { } ``` +!!! note + Dokka extracts the information about sourcesets from the Kotlin Gradle plugin. + Therefore, if you are using Dokka in a [precompiled script plugin](https://docs.gradle.org/current/userguide/custom_plugins.html#sec:precompiled_plugins), + you will have to add a depencency to the Kotlin Gradle Plugin as well + (`implementation(kotlin("gradle-plugin", ""))` resp. `implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:")`). + +Please + ## Configuration options Dokka documents single-platform as well as multi-platform projects. @@ -370,4 +378,4 @@ tasks.dokkaHtmlPartial.configure { Please see the [Dokka Gradle single module example project](https://github.com/Kotlin/dokka/tree/master/examples/gradle/dokka-gradle-example) or [multimodule](https://github.com/Kotlin/dokka/tree/master/examples/gradle/dokka-multimodule-example) for an example. -Also see [generated documentation](https://Kotlin.github.io/dokka/examples/dokka-gradle-example/html) in `HTML` format. \ No newline at end of file +Also see [generated documentation](https://Kotlin.github.io/dokka/examples/dokka-gradle-example/html) in `HTML` format.