Dokka¶
Dokka
is an API documentation engine for Kotlin
that performs the same function as the Javadoc
tool for Java
,
but it's modern and highly pluggable.
Just like Kotlin
itself, Dokka
supports mixed-language projects (Kotlin
/Java
). It understands
KDoc comments in Kotlin
source files as well
as Javadoc comments in Java
files, and can generate documentation in multiple formats including its own HTML
format, Java's Javadoc
lookalike
and Markdown
.
Some libraries that use Dokka
for API reference docs:
Dokka
provides support for the following build systems:
- Gradle (preferred)
- Maven
- Command line
Dokka
is also very pluggable and comes with convenient plugin and extension point API.
You can write a plugin to support mermaid.js diagrams, mathjax formulas or even write custom processing of your own tags and annotations.
For more info, see: