Android Studio Javadoc，如何包含 overview.html？

Question

我想将我的 overview.html 文件合并到生成的 java 文档中。使用 "ordinary" java 我只是在包源目录中的 .java 文件旁边添加了一个 overview.html 文件并且它起作用了。

在 Android Studio Javadoc 对话框中，我将其添加到 其他命令行参数 字段中：

-概览overview.html

但是它从来没有找到这个文件。我总是得到： javadoc: 错误 - 读取文件时出错 overview.html 唯一可行的是，如果我对完整路径进行硬编码。 (-overview c:....\overview.html) 但这看起来很尴尬。

我试过overview.html四处移动，但无济于事。

overview.html 文件本身很简单，像这样：

<html>
<body>
<p>[S. Yawn, Bureaucratosis] Gas mine treaty blah blah bl-blah </p>
</body>
</html>

我怀疑一种可能性是更改 build.gradle 文件以手动将概览文件复制到 Android 在构建 java 文档时用作源目录的构建目录.但我承认我还没有深入研究这个想法。

Answer 1

您可以使用 Gradle 执行此操作。在您的 app/build.gradle 中，您必须添加一个 javadoc 任务：

task javadoc(type: Javadoc) {
    source = android.sourceSets.main.java.srcDirs
    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
    destinationDir = file("../javadoc/")
    failOnError false
}

要自动将您的 overview.html 添加为索引，请按以下方式扩展脚本：

task javadoc(type: Javadoc) {
    source = android.sourceSets.main.java.srcDirs
    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
    destinationDir = file("../javadoc/")
    failOnError false
    options.overview = "src/main/javadoc/overview.html"
}

然后您可以将 javadoc 添加到 jar 中并将其作为存档发布：

task javadocJar(type: Jar, dependsOn: javadoc) {
    classifier = 'javadoc'
    from javadoc.destinationDir
}

artifacts {
    archives javadocJar
}

Android Studio Javadoc，如何包含 overview.html？

Android Studio Javadoc, how to include overview.html?

javadoc

intellij-idea

android-studio

android-gradle-plugin