Skip to content

Commit

Permalink
Add a note about usage in a precompiled script plugin
Browse files Browse the repository at this point in the history
see #2301
  • Loading branch information
chkpnt committed Jan 12, 2022
1 parent 09e9950 commit 5880cb7
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/src/doc/docs/user_guide/gradle/usage.md
Expand Up @@ -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.
Expand Down

0 comments on commit 5880cb7

Please sign in to comment.