Skip to content
Alpha

Javadoc

このガイドは Dokka Gradle plugin (DGP) v2 モードに適用されます。DGP v1 モードは現在サポートされていません。 v1 から v2 モードへのアップグレードについては、マイグレーションガイドに従ってください。

Dokka の Javadoc 出力形式は、Java の Javadoc HTML 形式に似せて作られています。

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

Javadoc 出力形式のスクリーンショット

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

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

Javadoc ドキュメントの生成 ​

Dokka は、マルチプロジェクトビルドまたは Kotlin マルチプラットフォームプロジェクトにおける Javadoc 形式をサポートしていません。

Dokka 用の Gradle プラグインには Javadoc 出力形式が含まれています。プロジェクトの build.gradle.kts ファイルの plugins {} ブロックで、対応するプラグイン ID を適用する必要があります。

kotlin
plugins {
    id("org.jetbrains.dokka-javadoc") version "2.2.0"
}

プラグインを適用すると、以下のタスクを実行できます。

  • dokkaGenerate: 適用されたプラグインに基づき、利用可能なすべての形式でドキュメントを生成します。
  • dokkaGeneratePublicationJavadoc: Javadoc 形式でのみドキュメントを生成します。

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

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

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

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

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

コマンドラインオプション経由:

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

JSON 設定経由:

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

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