From b30db0aeafd5663dce3d3020f3dde6599ec368f3 Mon Sep 17 00:00:00 2001 From: Gregor Dschung Date: Wed, 12 Jan 2022 14:00:36 +0100 Subject: [PATCH] Add a note about usage in a precompiled script plugin (#2303) Fix for #2301 --- docs/src/doc/docs/user_guide/gradle/usage.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/src/doc/docs/user_guide/gradle/usage.md b/docs/src/doc/docs/user_guide/gradle/usage.md index 3570133cdc..18ef178376 100644 --- a/docs/src/doc/docs/user_guide/gradle/usage.md +++ b/docs/src/doc/docs/user_guide/gradle/usage.md @@ -60,6 +60,12 @@ 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:")`). + ## Configuration options Dokka documents single-platform as well as multi-platform projects.