如何使用Gradle在Android Studio中生成JavaDoc? [英] How to use Gradle to generate JavaDoc in Android Studio?

问题描述

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

I can not find any documentation on how to configure my Gradle file to create the JavaDoc for my project. I already tried some snippets from SO and blog articles but none of them seem to work or they do not provide context.

这是我的Gradle文件.我需要做些什么来添加任务来生成JavaDoc?

This is my Gradle file. What do I need to do to add a task to generate 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'
}

推荐答案

在我们的项目中，我们在应用程序的build.gradle中添加了以下内容:

In our projects we added the following to the app's 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版本，这将添加以下任务:

This will add tasks to the build of the form generate<build_variant>Javadoc. So let's say you have a free and a pro version of your app, this would add tasks like:

generateFreeDebugJavadoc
generateFreeReleaseJavadoc
generateProDebugJavadoc
generateProReleaseJavadoc

希望这会有所帮助

这篇关于如何使用Gradle在Android Studio中生成JavaDoc?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！