JavaDoc,如何通过gradle任务为特定类生成文档?

问题描述

我对此post进行了调查,但这对我没有帮助。

我的任务是只为特定的类生成javadoc。

sourceSets {
    main {
        java {
            srcDir 'src/main/java/com/project/module'
        }
    }
}

task javadocApi(type: Javadoc) {
    source = sourceSets.main.java.srcDirs
    classpath = sourceSets.main.java.srcDirs()
    destinationDir = file("../javadoc/")
    include("**/ClassObject.java")
    include("**/ClassListener.java")
    failOnError true
}

运行任务javadocApi时出现此错误:

错误:这些类ClassObject和ClassListener中的整个代码都不存在android.app包

[错误] [org.gradle.internal.buildevents.BuildExceptionReporter]> Javadoc生成失败。生成的Javadoc选项文件(用于故障排除):'/Users/user/Documents/Projects/project/Developement/Sources/moduleaandroid/android/build/tmp/javadocApi/javadoc.options'

解决方法

好吧,经过一番尝试,我找到了这个解决方案:

 task generateApiDoc(type: Javadoc) {
    failOnError false
    final Properties properties = new Properties()
    properties.load(project.rootProject.file('local.properties').newDataInputStream())
    final def sdkDir = properties.getProperty('sdk.dir')
    options.bootClasspath(new File(sdkDir + "/platforms/android-30/android.jar"))
    source = android.sourceSets.main.java.srcDirs
    classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
    classpath += configurations.compile
    destinationDir = file("../release/Resources/JavaDoc")
    include("**/ClassName.java")
    include("**/ClassName.java")
}

相关问答

错误1:Request method ‘DELETE‘ not supported 错误还原:...
错误1:启动docker镜像时报错:Error response from daemon:...
错误1:private field ‘xxx‘ is never assigned 按Alt...
报错如下,通过源不能下载,最后警告pip需升级版本 Requirem...