防止 Javadoc 使 gradle 构建失败答案

【问题标题】：prevent Javadoc from failing gradle build防止 Javadoc 使 gradle 构建失败
【发布时间】：2016-05-27 21:16:30
【问题描述】：

我正在尝试将我的库项目上传到 jCenter。当我运行gradlew install 时出现错误：

任务 ':myLibraryProject:javadoc' 执行失败

我将以下代码添加到我的库项目中：

task androidJavadocs(type: Javadoc) {
    failOnError false // add this line
    source = android.sourceSets.main.java.getSrcDirs()
}

但我还是明白了

“Javadoc 生成失败。生成的 Javadoc 选项文件...”

我也尝试过这里接受的答案：Generate JavaDocs with Android Gradle plugin

我可以禁用 Javadocs 的生成，还是尝试在失败后继续构建？

【问题讨论】：

我在这里找到了禁用 JavaDocs 任务的解决方案：stackoverflow.com/questions/34874175/…
该解决方案禁用 Javadoc 任务运行，这与防止构建因代码中的错误 Javadoc 而失败不同。
检查您拥有的文件很有帮助，我的是错误的导入（Android 数据绑定库）。通过在 build.gradle (lib) 上的 android{...} 中添加正确的配置 (dataBinding { enabled = true }) 来修复。不幸的是，问题仍然存在:(。

标签： android android-gradle-plugin

【解决方案1】：

将这些行添加到您的模块build.gradle

tasks.withType(Javadoc) {
      failOnError false
      options.addStringOption('Xdoclint:none', '-quiet')
      options.addStringOption('encoding', 'UTF-8')
      options.addStringOption('charSet', 'UTF-8')
}

或者您可以添加这些：

android.libraryVariants.findAll { variant -> variant.name == 'Release' } each { variant ->
    task("generate${variant.name}Javadoc", type: Javadoc) {
        description "Generates Javadoc for $variant.name."
        source = variant.javaCompile.source
        ext.androidJar = "${android.plugin.sdkDirectory}/platforms/${android.compileSdkVersion}/android.jar"
        classpath = files(variant.javaCompile.classpath.files) + files(ext.androidJar)
    }

    task("bundle${variant.name}Javadoc", type: Zip) {
        description "Bundles Javadoc into zip for $variant.name."
        classifier = "javadoc"
        from tasks["generate${variant.name}Javadoc"]
    }

【讨论】：

适用于failOnError字段

【解决方案2】：

我不建议禁用 JavaDoc 生成。相反，尝试运行

./gradlew javadoc

这应该会为您提供有关正在发生的警告和错误的详细日志输出。修复这些错误应该可以防止 JavaDoc 导致失败。

【讨论】：

试过这个，JAVADOC 生成成功，但还是出现上面提到的错误。
@DeepPatel，对我来说，我必须修复详细日志输出中列出的特定错误。

【解决方案3】：

在我们的例子中，问题是我们必须删除 .gitignore 文件。它们列在文件 javadoc.options 中。之后，任务就成功完成了。

【讨论】：