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 authored Jan 11, 2022
1 parent b8ffe63 commit ac3a2c1
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/src/doc/docs/user_guide/gradle/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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", "<kotlin-version>"))` resp. `implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:<kotlin-version>")`).

Please

## Configuration options

Dokka documents single-platform as well as multi-platform projects.
Expand Down Expand Up @@ -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.
Also see [generated documentation](https://Kotlin.github.io/dokka/examples/dokka-gradle-example/html) in `HTML` format.

0 comments on commit ac3a2c1

Please sign in to comment.