gradle-android-javadoc-plugin - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #typescript #llm #go #machine-learning #nodejs #windows #cli #awesome-list #vue #openai #open-source

gradle-android-javadoc-plugin

(★ 78)

Gradle plugin that generates Java Documentation from an Android Gradle project.

File Explorer

Download Latest Version (.zip)

- deploy_snapshot.sh
- - gradle-wrapper.jar
  - gradle-wrapper.properties
.gitignore
.travis.yml
build.gradle
CHANGELOG.md
gradle.properties
gradlew
gradlew.bat
LICENSE
README.md
settings.gradle

# Installation Guide

1. Get the code

git clone https://github.com/vanniktech/gradle-android-javadoc-plugin

Downloads the entire project code from GitHub to your computer.

cd gradle-android-javadoc-plugin

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

classpath "com.vanniktech:gradle-android-javadoc-plugin:0.3.0"

Builds the project using Gradle.

classpath "com.vanniktech:gradle-android-javadoc-plugin:0.4.0-SNAPSHOT"

Builds the project using Gradle.

./gradlew generateDebugJavadoc

Builds the project using Gradle.

./gradlew generateReleaseJavadoc

Builds the project using Gradle.

./gradlew generateJavadoc

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# gradle-android-javadoc-plugin

Gradle plugin that generates Java Documentation from an Android Gradle project.

# Set up

**app/build.gradle** or **library/build.gradle**

```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](https://plugins.gradle.org/plugin/com.vanniktech.android.javadoc)

### Snapshot

```gradle
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

```gradle
./gradlew generateDebugJavadoc
./gradlew generateReleaseJavadoc
```

or to run javadoc task for all variants :

```gradle
./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 :

```gradle
./gradlew generateJavadocJar
```

## Customize Plugin

```groovy
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