Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a note about usage in a precompiled script plugin #2303

Merged
merged 1 commit into from Jan 12, 2022
Merged

Add a note about usage in a precompiled script plugin #2303

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/src/doc/docs/user_guide/gradle/usage.md
View file
Open in desktop
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