Provides the ability to aggregate Javadocs across all projects in a multi-project build.
Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
gradle
src
.gitignore
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE
README.md
build.gradle
dependencies.lock
gradle.properties.enc
gradlew
gradlew.bat
settings.gradle

README.md

gradle-aggregate-javadocs-plugin

Support Status Build Status Coverage Status Gitter Apache 2.0

In a multi-project setup containing one or many Java-based projects, Javadocs are only created for individual subprojects. There are certain use cases that requires you merge Javadocs for all subprojects of your build. Creating a reusable library that is partitioned into sub-functionality but shipped together is a typical example. This plugin adds a task to the root project of the build allowing to aggregate Javadocs across all subprojects.

Usage

Applying the Plugin

To include, add the following to your build.gradle

buildscript {
    repositories { jcenter() }

    dependencies {
        classpath 'com.netflix.nebula:gradle-aggregate-javadocs-plugin:2.2.+'
    }
}

apply plugin: 'nebula-aggregate-javadocs'

Aggregating Javadocs

To aggregate Javadocs across all subprojects, execute the task aggregateJavadocs available to the root project. The task declares a task dependencies on the task javadoc provided by the Java plugin. The resulting Javadoc report is located in the directory project.buildDir/docs/javadoc.