Dokkaを始める

以下に、Dokkaの利用を開始するのに役立つ簡単な手順を示します。

Gradle Kotlin DSLGradle Groovy DSLMaven

これらの手順は、Dokka Gradleプラグインv1の設定とタスクを反映しています。Dokka 2.0.0以降、いくつかの設定オプション、Gradleタスク、およびドキュメント生成の手順が更新されました。これには以下が含まれます。

• 設定オプションの調整
• マルチモジュールプロジェクトの操作
• 更新されたタスクでのドキュメントの生成
• 出力ディレクトリの指定

Dokka Gradleプラグインv2における詳細および変更点の全リストについては、マイグレーションガイドを参照してください。

プロジェクトのルートビルドスクリプトにDokkaのGradleプラグインを適用します。

plugins {
    id("org.jetbrains.dokka") version "2.0.0"
}

マルチプロジェクトビルドをドキュメント化する場合、サブプロジェクト内にもGradleプラグインを適用する必要があります。

subprojects {
    apply(plugin = "org.jetbrains.dokka")
}

ドキュメントを生成するには、以下のGradleタスクを実行します。

• dokkaHtml (シングルプロジェクトビルドの場合)
• dokkaHtmlMultiModule (マルチプロジェクトビルドの場合)

デフォルトでは、出力ディレクトリは /build/dokka/html および /build/dokka/htmlMultiModule に設定されています。

GradleでDokkaを使用する方法の詳細については、Gradleを参照してください。

プロジェクトのルートビルドスクリプトにDokkaのGradleプラグインを適用します。

plugins {
    id 'org.jetbrains.dokka' version '2.0.0'
}

マルチプロジェクトビルドをドキュメント化する場合、サブプロジェクト内にもGradleプラグインを適用する必要があります。

subprojects {
    apply plugin: 'org.jetbrains.dokka'
}

ドキュメントを生成するには、以下のGradleタスクを実行します。

• dokkaHtml (シングルプロジェクトビルドの場合)
• dokkaHtmlMultiModule (マルチプロジェクトビルドの場合)

デフォルトでは、出力ディレクトリは /build/dokka/html および /build/dokka/htmlMultiModule に設定されています。

GradleでDokkaを使用する方法の詳細については、Gradleを参照してください。

DokkaのMavenプラグインをPOMファイルのpluginsセクションに追加します。

<build>
    <plugins>
        <plugin>
            <groupId>org.jetbrains.dokka</groupId>
            <artifactId>dokka-maven-plugin</artifactId>
            <version>2.0.0</version>
            <executions>
                <execution>
                    <phase>pre-site</phase>
                    <goals>
                        <goal>dokka</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

ドキュメントを生成するには、dokka:dokka ゴールを実行します。

デフォルトでは、出力ディレクトリは target/dokka に設定されています。

MavenでDokkaを使用する方法の詳細については、Mavenを参照してください。