Javadoc
Dokka 的 Javadoc 输出格式与 Java 的 Javadoc HTML 格式 类似.
它试图在视觉效果上模仿由 Javadoc 工具生成的 HTML 页面, 但它不是 Javadoc 的直接实现, 也不是完全一样的复制.
所有的 Kotlin 代码和签名都会以 Java 的视角来显示. 这是通过我们的 Kotlin as Java Dokka plugin 来实现的, 这个 plugin 是 Dokka 默认附带的, 而且对这个格式会默认使用.
Javadoc 输出格式作为一个 Dokka plugin 来实现, 由 Dokka 开发组维护. 它是开源的, 源代码请参见 GitHub.
生成 Javadoc 文档
Gradle plugin for Dokka 包含了 Javadoc 输出格式. 你可以使用以下 task:
Task | 描述 |
---|---|
| 为单个项目生成 Javadoc 文档. |
| 只为多项目构建中的父项目创建的 |
javadoc.jar
文件可以单独生成. 详情请参见, 构建 javadoc.jar
.
Maven plugin for Dokka 包含了 Javadoc 输出格式. 你可以使用以下 goal 生成文档:
Goal | 描述 |
---|---|
| 生成 Javadoc 格式文档 |
| 生成 |
由于 Javadoc 输出格式是一个 Dokka plugin, 因此你需要 下载 plugin 的 JAR 文件.
Javadoc 输出格式有 2 个依赖项, 你需要通过额外的 JAR 文件的方式提供:
通过 命令行选项 方式:
通过 JSON 配置 方式:
更多详情, 请参见 CLI 运行器文档中的 其他输出格式.