Skip to content

Commit

Permalink
Clarify where to apply the android plugin
Browse files Browse the repository at this point in the history
This is in response to this comment Kotlin#2227 (comment)
We spent a fair amount of time trying to figure out why it wasn't working for us & putting this extra line
in the documentation would've saved us a lot of time.
  • Loading branch information
CharlesG-Branch committed Feb 17, 2022
1 parent 8767bb8 commit d38fccf
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Expand Up @@ -79,6 +79,10 @@ apply(plugin= "org.jetbrains.dokka")
```

```kotlin
dependencies {
dokkaHtmlPlugin("org.jetbrains.dokka:android-documentation-plugin:${dokka_version}")
}

dokkaHtml.configure {
dokkaSourceSets {
named("main") {
Expand All @@ -88,6 +92,9 @@ dokkaHtml.configure {
}
```

**NOTE:** replace `Html` in the above code with whatever [output format](#output_formats) you need.


#### Multi-module projects
For documenting Gradle multi-module projects, you can use `dokka${format}Multimodule` tasks.

Expand Down

1 comment on commit d38fccf

@billmote
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the love of all things holy, why is this missing from the documentation? Thank you for this pull request. I've been killing myself trying to figure out why @hide is not working.

Please sign in to comment.