gradle-aggregate-javadocs-plugin

Aggregates Javadocs across all projects in a multi-project build

License	The Apache Software License, Version 2.0
Categories	Gradle Build Tools Net
GroupId	com.netflix.nebula
ArtifactId	gradle-aggregate-javadocs-plugin
Last Version	3.0.1
Release Date	Oct 27, 2015
Type	jar
Description	gradle-aggregate-javadocs-plugin Aggregates Javadocs across all projects in a multi-project build
Project URL	https://github.com/nebula-plugins/gradle-aggregate-javadocs-plugin
Source Code Management	https://github.com/nebula-plugins/gradle-aggregate-javadocs-plugin.git

Download gradle-aggregate-javadocs-plugin

Filename	Size
gradle-aggregate-javadocs-plugin-3.0.1.pom
gradle-aggregate-javadocs-plugin-3.0.1.jar	9 KB
gradle-aggregate-javadocs-plugin-3.0.1-sources.jar	2 KB
gradle-aggregate-javadocs-plugin-3.0.1-javadoc.jar	1 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.netflix.nebula/gradle-aggregate-javadocs-plugin/ -->
<dependency>
    <groupId>com.netflix.nebula</groupId>
    <artifactId>gradle-aggregate-javadocs-plugin</artifactId>
    <version>3.0.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.netflix.nebula/gradle-aggregate-javadocs-plugin/
implementation 'com.netflix.nebula:gradle-aggregate-javadocs-plugin:3.0.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.netflix.nebula/gradle-aggregate-javadocs-plugin/
implementation ("com.netflix.nebula:gradle-aggregate-javadocs-plugin:3.0.1")

Apache Buildr

'com.netflix.nebula:gradle-aggregate-javadocs-plugin:jar:3.0.1'

Apache Ivy

<dependency org="com.netflix.nebula" name="gradle-aggregate-javadocs-plugin" rev="3.0.1">
  <artifact name="gradle-aggregate-javadocs-plugin" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.netflix.nebula', module='gradle-aggregate-javadocs-plugin', version='3.0.1')
)

Scala SBT

libraryDependencies += "com.netflix.nebula" % "gradle-aggregate-javadocs-plugin" % "3.0.1"

Leiningen

[com.netflix.nebula/gradle-aggregate-javadocs-plugin "3.0.1"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

gradle-aggregate-javadocs-plugin

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.

Netflix Build Language Plugins

Versions

Version
3.0.1 Oct 27, 2015
2.2.1 Apr 8, 2015