Clarify where to apply the android plugin #2370
Conversation
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.
| dependencies { | ||
| dokkaHtmlPlugin("org.jetbrains.dokka:android-documentation-plugin:${dokka_version}") | ||
| } |
There was a problem hiding this comment.
Since not everyone needs this plugin and there's no explanation of what it's used for, I'd rather have it described separately down below, in the end of the Android section.
Something like
In order to improve documentation experience on Android platform (such as support for
@hidetag), consider adding the android plugin:dependencies { dokkaHtmlPlugin("org.jetbrains.dokka:android-documentation-plugin:${dokka_version}") }
And the same dokkaHtmlPlugin("org.jetbrains.dokka:android-documentation-plugin:${dokka_version}") could be added to that page as well (website doc files are in the docs module).
What do you think about that?
There was a problem hiding this comment.
I'll respond to both of your comments here as they're pretty related.
I'd expect that the section on android has all of the configuration needed for an android project & that I'd just need to copy paste the example to get all of it.
My team found the plugin system pretty confusing. That might just be because we wanted to throw the config in gradle and not think about it that much, but I'd also argue that's how the vasty majority of people will be using the library. It could also be that whenever I see a "org.jetbrains.dokka:android-documentation-plugin:${dokka_version}" my lizard brain just immediately associates that with implementation commands etc, but IMHO that's another argument to make it more copy paste friendly.
After diving into the project more it did make sense.
| @@ -88,6 +92,9 @@ dokkaHtml.configure { | |||
| } | |||
| ``` | |||
|
|
|||
| **NOTE:** replace `Html` in the above code with whatever [output format](#output_formats) you need. | |||
There was a problem hiding this comment.
I feel like this was explained in the using the gradle plugin and applying plugins sections:
The plugin adds dokkaHtml, dokkaJavadoc, dokkaGfm and dokkaJekyll tasks to the project.
Dokka plugin creates Gradle configuration for each output format in the form of dokka${format}Plugin:
I think it's a good idea to keep README.md short, do you really think it's worth to have it here?
This can definitely be added to android plugin page, won't hurt
This is in response to this comment #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. cc @IgnatBeresnev