Question

我想将overview.html文件合并到生成的javadoc中。随着＆＃34;普通＆＃34; java我刚刚在包源目录中的.java文件旁边添加了一个overview.html文件，并且它有效。

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

-overview overview.html

但它永远找不到这个文件。我总是得到： javadoc：error - 读取文件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文件以手动将概述文件复制到构建javadocs时Android用作源目录的构建目录。但我承认我还没有挖掘过这个想法。

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"
}

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

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

artifacts {
    archives javadocJar
}

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

1 个答案: