vanniktech / Gradle Android Javadoc Plugin
Licence: apache-2.0
Gradle plugin that generates Java Documentation from an Android Gradle project.
Stars: ✭ 73
Programming Languages
shell
77523 projects
Labels
Projects that are alternatives of or similar to Gradle Android Javadoc Plugin
Prefiller
Prefiller is a Gradle plugin that generates pre-filled Room databases at compile time.
Stars: ✭ 43 (-41.1%)
Mutual labels: gradle-plugin
Gradle Docker Plugin
Gradle plugin for managing Docker images and containers.
Stars: ✭ 994 (+1261.64%)
Mutual labels: gradle-plugin
Onesignal Gradle Plugin
Use with OneSignal-Android-SDK to help integrate it into your Android Studio or Gradle project. https://onesignal.com
Stars: ✭ 49 (-32.88%)
Mutual labels: gradle-plugin
Plantuml Gradle Plugin
Gradle plugin to build PlantUML diagrams from code (for living and up-to-date documentation)
Stars: ✭ 27 (-63.01%)
Mutual labels: gradle-plugin
Gradle Clover Plugin
Gradle plugin for generating a code coverage report using Clover
Stars: ✭ 67 (-8.22%)
Mutual labels: gradle-plugin
Hunter
A fast, incremental, concurrent framework to develop compile plugin for android project to manipulate bytecode
Stars: ✭ 999 (+1268.49%)
Mutual labels: gradle-plugin
Gradle S3 Build Cache
An AWS S3 Gradle build cache implementation
Stars: ✭ 54 (-26.03%)
Mutual labels: gradle-plugin
Gradle Teamcity Plugin
Gradle plugin for developing TeamCity plugins
Stars: ✭ 30 (-58.9%)
Mutual labels: gradle-plugin
Gradle Xjc Plugin
A Gradle plugin to run the XJC binding compiler during a build
Stars: ✭ 38 (-47.95%)
Mutual labels: gradle-plugin
Auto Manifest
Generates AndroidManifest.xml in simple libraries so that you don't have to
Stars: ✭ 51 (-30.14%)
Mutual labels: gradle-plugin
Gradle Kotlin Aspectj Weaver
A Gradle plugin that allows you to weave your compiled Java and Kotlin files with AspectJ
Stars: ✭ 14 (-80.82%)
Mutual labels: gradle-plugin
Gradle Archetype Plugin
Gradle plugin that creates projects from your own cookiecutter
Stars: ✭ 61 (-16.44%)
Mutual labels: gradle-plugin
Gradle Defaults
Plugin providing opinionated defaults for Gradle projects.
Stars: ✭ 7 (-90.41%)
Mutual labels: gradle-plugin
Enigma
Gradle Plugin - Obfuscator String Encryption (Android/Java)
Stars: ✭ 43 (-41.1%)
Mutual labels: gradle-plugin
Gradle Semantic Build Versioning
Gradle plugin to generate version-numbers and tags using semantic versioning
Stars: ✭ 69 (-5.48%)
Mutual labels: gradle-plugin
Gradle Gae Plugin
Gradle plugin that provides tasks for uploading, running and managing Google App Engine projects
Stars: ✭ 62 (-15.07%)
Mutual labels: gradle-plugin
Licensechecker
Gradle plugin to check that all Open Source Libraries in a project have been attributed
Stars: ✭ 52 (-28.77%)
Mutual labels: gradle-plugin
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
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].