Get started with Dokka

Edit page Last modified: 01 November 2023

Below you can find simple instructions to help you get started with Dokka.
Gradle Kotlin DSL
Gradle Groovy DSL
Maven
Apply the Gradle plugin for Dokka in the root build script of your project:
plugins {
id("org.jetbrains.dokka") version "1.9.10"
}

When documenting multi-project builds, you need to apply the Gradle plugin within
subprojects as well:
subprojects {
apply(plugin = "org.jetbrains.dokka")
}

To generate documentation, run the following Gradle tasks:

 dokkaHtml for single-project builds
 dokkaHtmlMultiModule for multi-project builds

By default, the output directory is set

to /build/dokka/html and /build/dokka/htmlMultiModule.

To learn more about using Dokka with Gradle, see Gradle.

Was this page helpful?

YesNo