{"repo":"Kotlin/dokka","free":true,"listed":false,"github":"https://github.com/Kotlin/dokka","clone":"git clone https://github.com/Kotlin/dokka.git","description":"API documentation engine for Kotlin","language":"Kotlin","stars":3802,"topics":["api-reference","documentation","dokka","kotlin"],"license":"Apache-2.0","category":"docs-static-sites","readme_excerpt":"Dokka Dokka is an API documentation engine for Kotlin. Just like Kotlin itself, Dokka supports mixed-language projects. It understands Kotlin's KDoc comments and Java's Javadoc comments. Dokka can generate documentation in multiple formats, including its own modern HTML format, multiple flavors of Markdown, and Java's Javadoc HTML. Some libraries that use Dokka for their API reference documentation: kotlinx.coroutines Bitmovin Hexagon Ktor OkHttp Gradle You can run Dokka using Gradle, Maven or from the command line. It is also highly pluggable. Documentation Comprehensive documentation for Dokka is available on kotlinlang.org Get started with Dokka Gradle Kotlin DSL Apply the Gradle plugin for Dokka in the root build script of your project: When documenting multi-project builds, you need to apply the Gradle plugin for Dokka within subprojects as well: Groovy DSL Apply Gradle plugin for Dokka in the root project: When documenting multi-project builds, you need to apply the Gradle plugin for Dokka within subprojects as well: 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 respectively. To learn more about the Gradle plugin for Dokka, see documentation for Gradle. Maven Add the Dokka Maven plugin to the plugins section of your POM file: To generate documentation, run the dokka:dokka goal. By def","default_branch":null,"files":null,"tree":[],"storefront":"/r/Kotlin","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Kotlin/dokka/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}