Android studio/Gradle javadoc任务

Question

我一直在努力设置一个gradle任务来为我的Android库生成Javadoc，但当其他库存在外部依赖时，文档生成就会失败。这似乎是一个常见的任务，但不知何故似乎没有一个简单的解决方案，例如，这个答案将揭示（手动重新生成分解的aar有点荒谬，而且，在Android Studio 3.0上，由于新的依赖性指令，即使这样也不再有效）。

然而，我注意到，通过Android Studio GUI（工具菜单）生成Javadoc效果很好——解决了对其他库的依赖关系等。那么这是如何工作的呢？这个菜单是否没有利用gradle任务生成Javadoc？

因为我需要使用gradle作为CI的一部分来生成Javadoc，所以我发现非常令人沮丧的是，没有文档化的方法来让它工作，而有一种方法可以通过菜单工作。Android Studio工具不是吗-

Answer 1

生成java样式留档的工具叫做javadoc，它安装在每个JDK中。您可以配置要包含哪些类或包，哪些应该排除，以及许多其他选项。在有JDK的终端中键入javadoc，您会得到一个想法。另请参见https://docs.oracle.com/javase/9/javadoc/javadoc.htm#JSJAV-GUID-7A344353-3BBF-45C4-8B28-15025DDCC643

达到最佳配置后，可以在CI中包含javadoc步骤。

Answer 2

我使用一个gradle任务，它只执行一个bash脚本文件，并使用一个（相当长的）javadoc命令。

您可以做的是从Android Studio运行一次Javadoc生成，然后使用所有正确的参数从Studio日志中复制已执行的Javadoc命令，并在gradle中自动执行相同的命令。

Answer 3

也许你已经有了解决方案。以防万一，下面是我如何为我的詹金斯CI生成API文档的。

task generateApiDoc() {
    group "reporting"
    description "Generates Javadoc."
}

android.libraryVariants.all { variant ->
    // Only consider release 
    if (variant.buildType.name == "release") {
        def task = project.tasks.create("generate${variant.name.capitalize()}Javadoc", Javadoc) {
            group "ApiDoc"
            description "Generates Javadoc for $variant.name."

            // Source files from the variant
            source = variant.javaCompiler.source
            // Classpath from the variant + android.jar
            classpath = variant.javaCompiler.classpath + files(prj.android.getBootClasspath()) + files("$buildDir/intermediates/classes/release")

            /* add the excluded packages */
            exclude "**/R**"
            exclude "**/BuildConfig*"

            options.windowTitle = "My Library"
            options.memberLevel = JavadocMemberLevel.PROTECTED
            options.linkSource false
            options.author = true
            //options.links("http://docs.oracle.com/javase/7/docs/api/", "http://d.android.com/reference");

            failOnError false
        }

        task.dependsOn assemble

        generateApiDoc.dependsOn task
    }
}

然后运行下面的gradle命令，将api文档替换为“$buildDir/docs”。

./gradlew assembleRelease
./gradlew generateApiDoc

编辑Gradle插件3.4.1

android.libraryVariants.all { variant ->

    def task = project.tasks.create("generate${variant.name.capitalize()}Javadoc", Javadoc) {
        title "API Documentation (${project.android.defaultConfig.versionName})"
        group "ApiDoc"
        description "Generates Javadoc for $variant.name."

        // Source files from the variant
        source = variant.sourceSets.collect { it.java.sourceFiles }.inject { m, i -> m + i }

        // To fix issue: Error: Can not create variant 'android-lint' after configuration ': library: debugRuntimeElements' has been resolved
        doFirst {
            classpath = project.files(variant.javaCompileProvider.get().classpath.files,
                    project.android.getBootClasspath())
        }

        if (JavaVersion.current().isJava8Compatible()) {
            options.addStringOption('Xdoclint:none', '-quiet')
        }

        exclude "**/R"
        exclude "**/R.**"
        exclude "**/R\$**"
        exclude "**/BuildConfig*"

        if (JavaVersion.current().isJava8Compatible()) {
            options.addStringOption('Xdoclint:none', '-quiet')
        }

        options.windowTitle = "API Documentation (${project.android.defaultConfig.versionName})"
        options.memberLevel = JavadocMemberLevel.PROTECTED
        options.linkSource false
        options.author = false

        failOnError true
    }

    task.dependsOn "assemble${variant.name.capitalize()}"
    generateApiDoc.dependsOn task
}