org.apache.maven.plugin.javadoc
Class AggregatorTestJavadocJar

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.TestJavadocJar
                  org.apache.maven.plugin.javadoc.AggregatorTestJavadocJar

All Implemented Interfaces:

ContextEnabled, Mojo

public class AggregatorTestJavadocJar
extends TestJavadocJar

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

Since:

2.6

Version:

$Id: AggregatorTestJavadocJar.html 829400 2012-08-19 17:42:28Z hboutemy $

Aggregates the Maven project and its child modules.

Is defined by the goal name:

test-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, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, OPTIONS_FILE_NAME, PACKAGES_FILE_NAME, project, skip, TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, useStandardDocletOptions

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

ROLE

Constructor Summary

AggregatorTestJavadocJar()

Method Summary

protected boolean

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

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

configureDependencySourceResolution, getClassifier, getCompileArtifacts, getDoctitle, getExecutionProjectSourceRoots, getJavadocDirectory, getOutputDirectory, getOverview, getProjectArtifacts, getProjectBuildOutputDirs, getProjectSourceRoots, getWindowtitle

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

execute

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

buildJavadocOptions, canGenerateReport, executeReport, failOnError, getAttachmentClassifier, getDependencySourcePaths, getFiles, getJavadocOptionsFile, getProject, getSourcePaths, logError, resolveDependency

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

AggregatorTestJavadocJar

public AggregatorTestJavadocJar()

Method Detail

isAggregator

protected boolean isAggregator()

Description copied from class: AbstractJavadocMojo

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