SetupWizardLibrary/tools/gradle/docs.gradle
Maurice Lam a211294e1c [SuwLib] Generate javadocs
Configure javadocs so that it can be generated with `./gradlew docs`
Split self.gradle from build.gradle, so that self.gradle can be used
to configure tasks only available to a build on ub-setupwizard-*,
while build.gradle will be used for building from source in other
gradle projects (e.g. GMS core).

Bug: 21444334
Change-Id: Icec763ce7dcf8939b7918b580e17ae22353cb38c
2015-08-10 18:04:09 +00:00

48 lines
1.9 KiB
Groovy

/**
* A helper gradle file to generate documentation using doclava.
* Include this file using `apply from` in the gradle build file. This will generate new tasks
* "javadoc<Variant>" which will generate javadocs for that target.
*/
import com.android.internal.doclava.DoclavaJavadocOptionFileOption
def DOCSDIR = "$rootDir/frameworks/opt/setupwizard/tools/docs"
android.libraryVariants.all { variant ->
if (variant.buildType.name.equals(com.android.builder.core.BuilderConstants.DEBUG)) {
return; // Skip debug builds.
}
def suffix = variant.name.capitalize()
def javadocTask = project.tasks.create(name: "javadoc${suffix}", type: Javadoc) {
title = null
source variant.javaCompile.source
classpath = files(variant.javaCompile.classpath.files) + files(
"${android.sdkDirectory}/platforms/${android.compileSdkVersion}/android.jar")
exclude '**/R.java'
exclude '**/R.html', '**/R.*.html'
exclude '**/BuildConfig.java'
options {
bootClasspath = files(android.getBootClasspath()).asType(List)
doclet = 'com.google.doclava.Doclava'
docletpath = files("$DOCSDIR/doclava.jar", "$DOCSDIR/jsilver.jar").asType(List)
addOption(new DoclavaJavadocOptionFileOption('offlinemode'))
addOption(new DoclavaJavadocOptionFileOption('federate'))
.setValue(['Android', 'http://developer.android.com'])
addOption(new DoclavaJavadocOptionFileOption('federationapi'))
.setValue(['Android', file("$DOCSDIR/android-22.txt").canonicalPath])
addStringOption('templatedir',
file("$rootDir/build/tools/droiddoc/templates-sdk-dev").canonicalPath)
}
dependsOn(variant.assemble)
doLast {
println "Docs generated: file://${project.docsDir}/javadoc/reference/index.html"
}
}
}