org.apache.maven.plugin.javadoc
Class AggregatorJavadocJar

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugin.javadoc.AbstractJavadocMojo
          org.apache.maven.plugin.javadoc.JavadocJar
              org.apache.maven.plugin.javadoc.AggregatorJavadocJar

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class AggregatorJavadocJar
extends JavadocJar

Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.

Since:

2.6

Version:

$Id: AggregatorJavadocJar.html 829394 2012-08-19 17:31:42Z hboutemy $

Aggregates the Maven project and its child modules.

Is defined by the goal name:

aggregate-jar

Is bound to the specified phase of the standard build lifecycle:

package

Field Summary

Fields inherited from class org.apache.maven.plugin.javadoc.AbstractJavadocMojo

aggregate, ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, DEFAULT_JAVA_API_LINKS, failOnError, FILES_FILE_NAME, links, OPTIONS_FILE_NAME, outputDirectory, PACKAGES_FILE_NAME, project, skip, useStandardDocletOptions

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

AggregatorJavadocJar()

Method Summary

protected boolean

isAggregator() Indicates whether this goal is flagged with @aggregator.

Methods inherited from class org.apache.maven.plugin.javadoc.JavadocJar

execute, getClassifier

Methods inherited from class org.apache.maven.plugin.javadoc.AbstractJavadocMojo

canGenerateReport, executeReport, getCompileArtifacts, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getOutputDirectory, getOverview, getProjectArtifacts, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getWindowtitle

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AggregatorJavadocJar

public AggregatorJavadocJar()

Method Detail

isAggregator

protected boolean isAggregator()

Indicates whether this goal is flagged with @aggregator.

Overrides:

isAggregator in class AbstractJavadocMojo

Returns:

true if the goal is designed as an aggregator, false otherwise.

See Also:

AggregatorJavadocReport, AggregatorTestJavadocReport