如何在Android Studio中使用Gradle生成JavaDoc？

Question

我找不到任何关于如何配置我的 Gradle 文件来为我的项目创建 JavaDoc 的文档。我已经尝试了 SO 和博客文章中的一些片段，但其中 none 似乎有效或者它们不提供上下文。

这是我的 Gradle 文件。添加生成JavaDoc的任务需要做什么？

import org.apache.tools.ant.taskdefs.condition.Os

apply plugin: 'com.android.library'

android {
    compileSdkVersion 21
    buildToolsVersion "21.1.2"

    defaultConfig {
        minSdkVersion 15
        targetSdkVersion 21
        versionCode 1
        versionName "1.0"
    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    compile 'com.android.support:appcompat-v7:21.0.3'
}

Answer 1

在我们的项目中，我们将以下内容添加到应用的 build.gradle：

android.applicationVariants.all { variant ->
  task("generate${variant.name.capitalize()}Javadoc", type: Javadoc) {
    description "Generates Javadoc for $variant.name."
    source = variant.javaCompile.source
    ext.androidJar = "${android.sdkDirectory}/platforms/${android.compileSdkVersion}/android.jar"
    classpath = files(variant.javaCompile.classpath.files) + files(ext.androidJar)
    options.links("http://docs.oracle.com/javase/7/docs/api/");
    options.links("http://d.android.com/reference/");
  }
}

这会将任务添加到表单 generate<build_variant>Javadoc 的构建中。假设您有一个 free 和一个 pro 版本的应用程序，这将添加如下任务：

generateFreeDebugJavadoc
generateFreeReleaseJavadoc
generateProDebugJavadoc
generateProReleaseJavadoc

希望这对您有所帮助

Answer 2

在 android studio 中，编写一个 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
  }

只需执行此任务即可创建 javadoc。

如何在Android Studio中使用Gradle生成JavaDoc？

How to use Gradle to generate JavaDoc in Android Studio?

android

javadoc

gradle

android-studio

android-gradle-plugin