Dokka 入门
下文提供了简明指引,帮助你开始使用 Dokka。
本指南适用于 Dokka Gradle 插件(DGP)v2 模式。DGP v1 模式已不再受支持。 要从 v1 升级到 v2 模式,请遵循迁移指南。
应用 Dokka Gradle 插件
在项目的根构建脚本中应用 Dokka Gradle 插件(DGP):
plugins {
id("org.jetbrains.dokka") version "2.2.0"
}为多项目构建生成文档
当为多项目构建生成文档时,你需要将该插件应用到每个想要生成文档的子项目中。可以通过以下方式之一在子项目之间共享 Dokka 配置:
- 约定插件(Convention plugin)
- 如果未使用约定插件,则在每个子项目中直接配置
要了解有关在多项目构建中共享 Dokka 配置的更多信息,请参阅多项目配置。
生成文档
要生成文档,请运行以下 Gradle 任务:
./gradlew :dokkaGenerate该任务同时适用于单项目和多项目构建。
通过在任务前加上项目路径(:),从聚合项目中运行 dokkaGenerate 任务。例如:
./gradlew :dokkaGenerate
// 或者
./gradlew :aggregatingProject:dokkaGenerate请避免使用 ./gradlew dokkaGenerate,而应使用 ./gradlew :dokkaGenerate 或 ./gradlew :aggregatingProject:dokkaGenerate。 如果没有在任务前指定项目路径(:),Gradle 会尝试在整个构建中运行所有的 dokkaGenerate 任务,这可能会触发不必要的工作。
你可以使用不同的任务来生成 HTML、Javadoc 或同时生成 HTML 和 Javadoc 输出。
要了解有关在 Gradle 中使用 Dokka 的更多信息,请参阅 Gradle。
本指南适用于 Dokka Gradle 插件(DGP)v2 模式。DGP v1 模式已不再受支持。 要从 v1 升级到 v2 模式,请遵循迁移指南。
应用 Dokka Gradle 插件
在项目的根构建脚本中应用 Dokka Gradle 插件(DGP):
plugins {
id 'org.jetbrains.dokka' version '2.2.0'
}为多项目构建生成文档
当为多项目构建生成文档时,你需要将该插件应用到每个想要生成文档的子项目中。可以通过以下方式之一在子项目之间共享 Dokka 配置:
- 约定插件(Convention plugin)
- 如果未使用约定插件,则在每个子项目中直接配置
要了解有关在多项目构建中共享 Dokka 配置的更多信息,请参阅多项目配置。
生成文档
要生成文档,请运行以下 Gradle 任务:
./gradlew :dokkaGenerate该任务同时适用于单项目和多项目构建。
通过在任务前加上项目路径(:),从聚合项目中运行 dokkaGenerate 任务。例如:
./gradlew :dokkaGenerate
// 或者
./gradlew :aggregatingProject:dokkaGenerate请避免使用 ./gradlew dokkaGenerate,而应使用 ./gradlew :dokkaGenerate 或 ./gradlew :aggregatingProject:dokkaGenerate。 如果没有在任务前指定项目路径(:),Gradle 会尝试在整个构建中运行所有的 dokkaGenerate 任务,这可能会触发不必要的工作。
你可以使用不同的任务来生成 HTML、Javadoc 或同时生成 HTML 和 Javadoc 输出。
要了解有关在 Gradle 中使用 Dokka 的更多信息,请参阅 Gradle。
将 Dokka 的 Maven 插件添加到 POM 文件的 plugins 部分中:
<build>
<plugins>
<plugin>
<groupId>org.jetbrains.dokka</groupId>
<artifactId>dokka-maven-plugin</artifactId>
<version>2.2.0</version>
<executions>
<execution>
<phase>pre-site</phase>
<goals>
<goal>dokka</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>要生成文档,请运行 dokka:dokka 目标(goal)。
默认情况下,输出目录被设置为 target/dokka。
要了解有关在 Maven 中使用 Dokka 的更多信息,请参阅 Maven。
