How to use Gradle to generate JavaDoc in Android Studio?

Question

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

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

In our projects, we added the following to the build.gradle application:

 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 generate<build_variant>Javadoc form. So, let's say you have a free and pro version of your application, this will add tasks such as:

 generateFreeDebugJavadoc generateFreeReleaseJavadoc generateProDebugJavadoc generateProReleaseJavadoc 

Hope this helps

Answer 2

In android studio, write a gradle task like 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 } 

Just complete this task by creating javadocs.