diff options
| author | Gregor Dschung <gregor@chkpnt.de> | 2022-01-12 14:00:36 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-12 16:00:36 +0300 |
| commit | b30db0aeafd5663dce3d3020f3dde6599ec368f3 (patch) | |
| tree | 37c08d60693eea0c1c8ff50635e968d746bc5cd6 /docs/src/doc | |
| parent | 09e9950eae7ff30e9a6959b6b24a8777199208c4 (diff) | |
| download | dokka-b30db0aeafd5663dce3d3020f3dde6599ec368f3.tar.gz dokka-b30db0aeafd5663dce3d3020f3dde6599ec368f3.tar.bz2 dokka-b30db0aeafd5663dce3d3020f3dde6599ec368f3.zip | |
Add a note about usage in a precompiled script plugin (#2303)
Fix for #2301
Diffstat (limited to 'docs/src/doc')
| -rw-r--r-- | docs/src/doc/docs/user_guide/gradle/usage.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/src/doc/docs/user_guide/gradle/usage.md b/docs/src/doc/docs/user_guide/gradle/usage.md index 3570133c..18ef1783 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", "<kotlin-version>"))` resp. `implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:<kotlin-version>")`). + ## Configuration options Dokka documents single-platform as well as multi-platform projects. |