The Javadoc output format is still in Alpha, so you may find bugs and experience migration issues when using it. Successful integration with tools that accept Java's Javadoc HTML as input is not guaranteed. You use it at your own risk.
Dokka's Javadoc output format is a lookalike of Java's Javadoc HTML format.
It tries to visually mimic HTML pages generated by the Javadoc tool, but it's not a direct implementation or an exact copy.
All Kotlin code and signatures are rendered as seen from Java's perspective. This is achieved with our Kotlin as Java Dokka plugin, which comes bundled and applied by default for this format.
Generate Javadoc documentation
The Javadoc format does not support multiplatform projects.
The Gradle plugin for Dokka comes with the Javadoc output format included. You can use the following tasks:
|Generates Javadoc documentation for a single project.
Collector task created only for parent projects in multi-project builds. It calls
dokkaJavadoc for every subproject and merges all outputs into a single virtual project.
javadoc.jar file can be generated separately. For more information, see Building
The Maven plugin for Dokka comes with the Javadoc output format built in. You can generate documentation by using the following goals:
|Generates documentation in Javadoc format
javadoc.jar file that contains documentation in Javadoc format
The Javadoc output format has two dependencies that you need to provide as additional JAR files:
Via command line options:
java -jar dokka-cli-1.7.20.jar \
-pluginsClasspath "./dokka-base-1.7.20.jar;...;./javadoc-plugin-1.7.20.jar" \
Via JSON configuration:
For more information, see Other output formats in the CLI runner's documentation.