Введение

Dokka — это движок для создания документации API на Kotlin.

Как и сам Kotlin, Dokka поддерживает проекты со смешанными языками. Он распознаёт комментарии KDoc в Kotlin и комментарии Javadoc в Java.

Dokka может генерировать документацию в нескольких форматах, включая собственный современный формат HTML, HTML Javadoc для Java, а также варианты Markdown GFM и Jekyll.

Ниже приведены некоторые библиотеки, использующие Dokka для создания справочной документации API:

• kotlinx.coroutines

• Bitmovin

• Hexagon

• Ktor

• OkHttp

Запустить Dokka можно с помощью Gradle, Maven или из командной строки. Кроме того, Dokka поддерживает множество подключаемых модулей.

Чтобы сделать первые шаги в работе с Dokka, ознакомьтесь с разделом Начало работы с Dokka.