微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

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

如何解决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")
}

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。