Javadoc

DANGER

Javadoc出力フォーマットはまだAlpha版であり、使用時にバグが見つかったり、移行に関する問題が発生したりする可能性があります。

JavaのJavadoc HTMLを入力として受け入れるツールとの統合が成功することは保証されません。

ご自身の責任においてご使用ください。

DokkaのJavadoc出力フォーマットは、Javaの Javadoc HTML形式の模倣です。

Javadocツールによって生成されるHTMLページを視覚的に模倣しようとしますが、直接的な実装や完全に同じものではありません。

Screenshot of javadoc output format

すべてのKotlinコードとシグネチャは、Javaの視点から見たようにレンダリングされます。これは、このフォーマットにバンドルされ、デフォルトで適用される Kotlin as Java Dokkaプラグインによって実現されます。

Javadoc出力フォーマットはDokkaプラグインとして実装されており、Dokkaチームによってメンテナンスされています。これはオープンソースであり、ソースコードはGitHubで見つけることができます。

Javadocドキュメントの生成

DANGER

Javadoc形式はマルチプラットフォームプロジェクトをサポートしていません。

CLI

Bash

java -jar dokka-cli-2.0.0.jar \
     -pluginsClasspath "./dokka-base-2.0.0.jar;...;./javadoc-plugin-2.0.0.jar" \
     ...