Dokka – API documentation engine for Kotlin

Dokka generates API documentation for Kotlin projects, including codebases that mix Kotlin and Java. It understands KDoc and Javadoc comments and combines them with information extracted from source declarations.

Its HTML output supports single-project and multi-project documentation, including libraries with APIs shared across multiple Kotlin platforms.

This is free and open source software.

Key Features

• Documents Kotlin declarations and Java source code within the same project.
• Processes KDoc and Javadoc comments to describe APIs alongside their signatures.
• Generates HTML references for Kotlin Multiplatform, Android, and Java projects.
• Combines documentation from multiple projects into a unified reference.
• Supports source-set configuration for controlling how platform-specific APIs are documented.
• Includes supplementary Markdown content for module introductions and package descriptions.
• Adds links from declarations to source files and specific lines in remote repositories.
• Links references to external API documentation, including dependencies documented separately.
• Includes sample functions referenced through KDoc sample tags.
• Controls documented visibility and allows selected packages or declarations to be suppressed.
• Offers controls for inherited members and obvious functions to reduce unnecessary reference content.
• Can report undocumented declarations and treat generation warnings as build failures.
• Customizes HTML presentation through stylesheets, images, templates, and footer content.
• Provides an extensible plugin architecture for modifying analysis, generation, and output.
• Offers Gradle and Maven integration alongside command-line execution for documentation workflows.
• Cross-platform support – runs on Linux, macOS, and Windows.

Website: github.com/Kotlin/dokka
Support:
Developer: JetBrains and contributors
License: Apache License 2.0

Dokka is written in Kotlin. Learn Kotlin with our recommended free books and free tutorials.

Related Software

Read our verdict in the software roundup.

LinuxLinks helps you discover the best free and open source software for Linux. Explore our extensive collection of recommended applications, including alternatives to popular proprietary software. We also publish software reviews, Linux tutorials, hardware reviews, free programming books and articles covering the wider open source community. Browse our Linux resources to discover more. Know a useful free and open source Linux application we haven't covered? Suggest a program for inclusion. Has your software been featured on LinuxLinks? Display one of our Featured on LinuxLinks badges on your website or GitHub README.