Skip to content

はじめに

Dokkaは、Kotlin向けのAPIドキュメントエンジンです。

Kotlin自体と同様に、Dokkaは混合言語プロジェクトをサポートしています。KotlinのKDocコメントとJavaのJavadocコメントを理解します。

Dokkaは、独自のモダンなHTML形式、JavaのJavadoc HTML、さらにMarkdownのGFMJekyllといった、複数の形式でドキュメントを生成できます。

以下は、APIリファレンスドキュメントにDokkaを使用しているライブラリの例です。

Dokkaは、GradleMaven、またはコマンドラインから実行できます。また、拡張性が非常に高いのも特徴です。

Dokkaを使い始めるための第一歩については、Dokkaを使ってみるを参照してください。

コミュニティ

KotlinコミュニティのSlackには専用の#dokkaチャンネルがあり、Dokkaやそのプラグイン、およびそれらの開発方法についてチャットしたり、メンテナンス担当者と連絡を取ったりすることができます。