gradle-android-javadoc-plugin
Gradle plugin that generates Java Documentation from an Android Gradle project.
Set up
app/build.gradle or library/build.gradle
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath "com.vanniktech:gradle-android-javadoc-plugin:0.3.0"
}
}
apply plugin: "com.vanniktech.android.javadoc"
Information: This plugin is also available on Gradle plugins
Snapshot
buildscript {
repositories {
maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
}
dependencies {
classpath "com.vanniktech:gradle-android-javadoc-plugin:0.4.0-SNAPSHOT"
}
}
apply plugin: "com.vanniktech.android.javadoc"
Get Javadoc
./gradlew generateDebugJavadoc
./gradlew generateReleaseJavadoc
or to run javadoc task for all variants :
./gradlew generateJavadoc
HTML reports
<subproject>/build/docs/javadoc/debug/index.html
<subproject>/build/docs/javadoc/release/index.html
Get Javadoc archive
./gradlew generateDebugJavadocJar
./gradlew generateReleaseJavadocJar
or to run javadoc archive task for all variants :
./gradlew generateJavadocJar
Customize Plugin
androidJavadoc {
// variantFilter takes a closure that received an Android variant as parameter.
// Return true to generate javadoc task for this variant, false to do nothing
// This is the default closure :
variantFilter { variant ->
if (variant) {
return true
} else {
return false
}
}
// taskNameTransformer takes a closure to customise the task name.
// Task name pattern is "generate${taskNameTransformer(variant).capitalize()}Javadoc"
// This is the default implementation :
taskNameTransformer { variant ->
variant.name
}
// outputDir return the documentation output dir
// Default implementation :
outputDir = { Project project ->
"${project.buildDir}/docs/javadoc/"
}
}
License
Copyright (C) 2015 Vanniktech - Niklas Baudy
Licensed under the Apache License, Version 2.0
