Question

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

这是我的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中，编写一个类型为Javadoc的gradle任务：

 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
  }

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

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

2 个答案: