防止Javadoc失败gradle构建

时间:2016-02-16 14:28:34

标签: android android-gradle

我正在尝试将我的图书馆项目上传到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

我是否可以禁用Javadoc的生成,或者尝试继续构建尽管失败?

3 个答案:

答案 0 :(得分:2)

将这些行添加到模块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"]
    }

答案 1 :(得分:1)

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

答案 2 :(得分:1)

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

./gradlew javadoc

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