Gradle不生成Javadocs

Question

我正在用Gradle编写一个构建文件来执行Java构建操作。然而，Gradle并没有为我的项目生成Javadocs。格拉德尔说。org的文档，要在Gradle中实现Javadocs任务，必须指定源和类路径。

apply plugin: 'java'

javadoc {
source = sourceSets.main.allJava
classpath = configurations.compile
}

但是，当我运行命令gradle javadoc或gradle build时，javadocs的默认文件夹（build\docs）永远不会创建，因此不会为项目生成html文件。我能做些什么来解决这个问题？

Answer 1

出于各种原因，我们在gradle中为我们的java项目创建了一个自定义类路径。主要是因为我们想把依赖关系分成运行时提供的依赖关系和运行时不提供的依赖关系。

所以我们这样设置build.gradle

configurations {
  providedCompile
}

dependencies {

  providedCompile  'provided1', 'provided2

  providedCompile  'provided3'

  compile 'compile1'
  compile ('compile2')   
  { 
        exclude group: 'unwanted part'
  }

}
sourceSets.main.compileClasspath += configurations.providedCompile
javadoc.classpath += configurations.providedCompile
sourceSets.test.compileClasspath += configurations.providedCompile
sourceSets.test.runtimeClasspath += configurations.providedCompile

我们需要添加最后一个部分，以便gradle能够正确地选择类路径，以便遵从、测试和运行javadoc。

Answer 2

您可以编写Javadoc类型的gradle任务来创建如下Javadoc：

 task createJavadocs (type: Javadoc)
      {
            source = project.android.sourceSets.main.java.srcDirs
            options.linkSource true
            classpath += project.files(project.android.getBootClasspath().join(File.pathSeparator))
            failOnError false
      }

要创建Javadocs，只需运行此任务。

Answer 3

看起来您的目录结构不是标准的src/main/java。如果是这样，那么您需要指定包含模式作为包含闭包的一部分，如下所示：

javadoc {
source = sourceSets.main.allJava
classpath = configurations.compile
}
include **/your/directory/structure/*