javadoc - 无法使用gradle将overview.html放入javadoc

Question

使用最新的 gradle，我试图让标准的 overview.html 出现在我的项目的 javadocs 中。我尝试了几种不同的配置方法，但都没有运气。这是最新的：

javadoc.ext["overview"] = "${projectDir}/src/main/java/overview.html"

没有报告错误，但是，概述简介不会出现在 javadocs 索引页面中。我可以让它从命令行或 IDE 调用 javadoc。

感谢您的帮助。（我已经检查了gradle 文档。）

Answer 1

不知道你是如何想出这种语法的。从任务的DSL参考Javadoc开始，您最终应该到达：

javadoc {
    options.overview = "overview.html" // relative to source root
}

根据 Javadoc 工具的文档，这似乎是默认设置，但仅当您至少有两个包时才会显示。

Answer 2

将文件overview.html放在目录src/main/java中。

现在更新你的build.gradle文件：

javadoc {
    options.overview = "src/main/java/overview.html"

}