无法使用Gradle将overview.html添加到Javadoc中

Question

使用最新版本的Gradle，我正在尝试让标准的overview.html在我的项目的javadocs中显示。我尝试了几种不同的配置方法，但都没有成功。以下是最新的尝试：

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

没有报告错误，但概述信息未出现在javadocs索引页面中。我可以通过从命令行或IDE调用javadoc来使其工作。

谢谢您的帮助。(我已经检查过gradle文档了。)

- evobo

Answer 1

不确定您是如何想到那个语法的。从Javadoc任务的DSL参考开始，您最终会得到：

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

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

- Peter Niederwieser

---

谢谢你的回答。对我有效的配置是：javadoc { options.overview = "src/main/java/overview.html" }对于其他走了和我一样的弯路的人，我是从以下开始的： - evobo

谢谢回答。对我有用的配置是： options.overview = "src/main/java/overview.html"对于其他和我一样陷入同样困境的人，我一开始使用了： overview = "src/main/java/overview.html" 但收到了这个警告： Dynamic properties are deprecated: http://gradle.org/docs/current/dsl/org.gradle.api.plugins.ExtraPropertiesExtension.html 由于那篇文档和我的天真，导致了我之前提出的配置问题。 - evobo

显然，overview.html的路径必须相对于源根目录（如答案中所述）。绝对路径对我无效。 - Jon

对我有效的是 javadoc {options.overview = "build/resources/main/overview.html"}。 - Nick H

这个答案非常令人困惑。评论中的“相对于源根目录”可能意味着许多不同的事情。/src或/src/main或/src/main/java或/src/resources或/src/main/java/com.example。无论如何，声明一个明确的路径src/main/java/overview.html（当然要把文件放在那里）是我让它工作所必需的。 - Ryan

Answer 2

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

现在更新您的build.gradle文件，添加以下内容：

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

}

- Ryan