Javadoc

Javadoc出力形式はまだアルファ版であるため、使用時にバグが見つかったり、移行に関する問題が発生したりする可能性があります。 JavaのJavadoc HTMLを入力として受け入れるツールとの正常な連携は保証されません。 ご自身の責任においてご使用ください。

DokkaのJavadoc出力形式は、Javaの Javadoc HTML形式を模倣したものです。

これはJavadocツールによって生成されたHTMLページを視覚的に模倣しようとしますが、直接的な実装や正確なコピーではありません。

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

Javadoc出力形式はDokkaプラグインとして実装されており、Dokkaチームによってメンテナンスされています。 これはオープンソースであり、ソースコードはGitHubで確認できます。

Javadocドキュメントの生成

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

GradleMavenCLI

Dokka用Gradleプラグインには、Javadoc出力形式が同梱されています。以下のタスクを使用できます。

タスク	説明
dokkaJavadoc	単一プロジェクトのJavadocドキュメントを生成します。
dokkaJavadocCollector	マルチプロジェクトビルドの親プロジェクト専用に作成されたCollectorタスクです。すべてのサブプロジェクトに対してdokkaJavadocを呼び出し、すべての出力を1つの仮想プロジェクトにマージします。

javadoc.jarファイルは別途生成できます。詳細については、javadoc.jarのビルドを参照してください。

Dokka用Mavenプラグインには、Javadoc出力形式が組み込まれています。以下のゴールを使用してドキュメントを生成できます。

ゴール	説明
dokka:javadoc	Javadoc形式でドキュメントを生成します
dokka:javadocJar	Javadoc形式のドキュメントを含むjavadoc.jarファイルを生成します

Javadoc出力形式はDokkaプラグインであるため、プラグインのJARファイルをダウンロードする必要があります。

Javadoc出力形式には、追加のJARファイルとして提供する必要がある2つの依存関係があります。

• kotlin-as-javaプラグイン
• korte-jvm

コマンドラインオプションを介して:

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

JSON設定を介して:

{
  ...
  "pluginsClasspath": [
    "./dokka-base-2.0.0.jar",
    "...",
    "./kotlin-as-java-plugin-2.0.0.jar",
    "./korte-jvm-3.3.0.jar",
    "./javadoc-plugin-2.0.0.jar"
  ],
  ...
}

詳細については、CLIランナーのドキュメントのその他の出力形式を参照してください。