Dokka 入門

以下是一些簡單的說明，協助您開始使用 Dokka。

Gradle Kotlin DSLGradle Groovy DSLMaven

在專案的根構建腳本中應用 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。

在 Dokka 2.0.0 中，一些入門步驟和任務已更新，其中包括：

• 配置多專案構建
• 使用更新的任務產生文件
• 指定輸出目錄

有關更多詳細資訊和完整的變更列表，請參閱 遷移指南。