Android 工作室/Gradle javadoc 任务

Question

我一直在努力设置一个 gradle 任务来为我的 Android 库生成 Javadocs，但是当其他库存在外部依赖项时，文档生成失败。这似乎是一个常见的任务，但不知何故似乎没有一个简单的解决方案，例如this answer 将揭示（手动重新生成爆炸aar 有点荒谬，而且，甚至在 Android Studio 3.0 上that doesn't work anymore 由于新的依赖指令）。

但是，我注意到通过 Android Studio GUI（工具菜单）生成 Javadoc 工作得很好——解决了对其他库的依赖等问题。那么这是如何工作的——这个菜单不使用 gradle 任务来生成 Javadoc 吗？

由于我需要使用 gradle 作为 CI 的一部分生成 Javadoc，我发现没有记录的方法让它工作，而有一种方法可以通过菜单工作，这非常令人沮丧。 Android Studio Tools -> Generate Javadoc 菜单不依次使用 gradle 任务吗？由于依赖项与 gradle 文件一起列出，并且 Javadoc 工具菜单显然能够解决这些依赖项 - 它是如何实现的？它如何获取嵌入在依赖 aar 库等中的 jar 包？它如何独立使用而不是通过 Android Studio GUI 使用？

Answer 1

也许您已经找到了解决方案。以防万一，下面是我如何为我的 Jenkins 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
}

Answer 2

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

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

Answer 3

生成 java 样式文档的工具称为 javadoc，它安装在每个 JDK 中。您可以配置要包含哪些类或包，应排除哪些类或包以及许多其他选项。在可以使用 JDK 的终端中键入 javadoc，您就会明白了。另见https://docs.oracle.com/javase/9/javadoc/javadoc.htm#JSJAV-GUID-7A344353-3BBF-45C4-8B28-15025DDCC643

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