wnchen/gradle-aggregate-javadocs-plugin

Provides the ability to aggregate Javadocs across all projects in a multi-project build.

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.wnchen:gradle-aggregate-javadocs-plugin:v3.0.1'
	}
	dependencies {
		implementation("com.github.wnchen:gradle-aggregate-javadocs-plugin:v3.0.1")
	}
	<dependency>
	    <groupId>com.github.wnchen</groupId>
	    <artifactId>gradle-aggregate-javadocs-plugin</artifactId>
	    <version>v3.0.1</version>
	</dependency>

                            
    libraryDependencies += "com.github.wnchen" % "gradle-aggregate-javadocs-plugin" % "v3.0.1"
        
        

                            
    :dependencies [[com.github.wnchen/gradle-aggregate-javadocs-plugin "v3.0.1"]]

Readme

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.