From d38fccf4c1026badbaa210ca297f4a4cc7feb657 Mon Sep 17 00:00:00 2001 From: Charles Date: Thu, 17 Feb 2022 13:07:58 -0800 Subject: [PATCH] Clarify where to apply the android plugin This is in response to this comment https://github.com/Kotlin/dokka/issues/2227#issuecomment-974580635 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. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 606b52eee4..ceec90f303 100644 --- a/README.md +++ b/README.md @@ -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") { @@ -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.