[英]How to use Gradle to generate JavaDoc in Android Studio?
I can not find any documentation on how to configure my Gradle file to create the JavaDoc for my project. 我找不到任何关于如何配置我的Gradle文件来为我的项目创建JavaDoc的文档。 I already tried some snippets from SO and blog articles but none of them seem to work or they do not provide context. 我已经尝试过SO和博客文章的一些片段,但它们似乎都没有用,或者它们没有提供上下文。
This is my Gradle file. 这是我的Gradle文件。 What do I need to do to add a task to generate JavaDoc? 添加任务以生成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'
}
In our projects we added the following to the app's build.gradle
: 在我们的项目中,我们将以下内容添加到应用程序的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/");
}
}
This will add tasks to the build of the form generate<build_variant>Javadoc
. 这将向表单generate<build_variant>Javadoc
的构建添加任务。 So let's say you have a free
and a pro
version of your app, this would add tasks like: 所以,假设你有一个free
和pro
版的应用程序,这将添加如下任务:
generateFreeDebugJavadoc
generateFreeReleaseJavadoc
generateProDebugJavadoc
generateProReleaseJavadoc
Hope this helps 希望这可以帮助
In android studio, write a gradle task of type Javadoc : 在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
}
Simply execute this task will create javadocs. 只需执行此任务即可创建javadoc。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.