org.apache.maven.plugin.javadoc
Class AggregatorTestJavadocReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugin.javadoc.AbstractJavadocMojo
          org.apache.maven.plugin.javadoc.JavadocReport
              org.apache.maven.plugin.javadoc.TestJavadocReport
                  org.apache.maven.plugin.javadoc.AggregatorTestJavadocReport

All Implemented Interfaces:

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

public class AggregatorTestJavadocReport
extends TestJavadocReport

Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool.

Since:

2.5

Version:

$Id: AggregatorTestJavadocReport.html 829396 2012-08-19 17:35:19Z hboutemy $

Author:

Vincent Siveton

Aggregates the Maven project and its child modules.

Is defined by the goal name:

test-aggregate

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, outputDirectory, PACKAGES_FILE_NAME, project, skip, TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, useStandardDocletOptions

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

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

ROLE

Constructor Summary

AggregatorTestJavadocReport()

Method Summary

protected boolean

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

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

configureDependencySourceResolution, executeReport, getCompileArtifacts, getDescription, getDoctitle, getExecutionProjectSourceRoots, getJavadocDirectory, getName, getOutputName, getOverview, getProjectArtifacts, getProjectBuildOutputDirs, getProjectSourceRoots, getReportOutputDirectory, getWindowtitle, setDestDir, setReportOutputDirectory

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

canGenerateReport, execute, generate, getCategoryName, isExternalReport

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

buildJavadocOptions, canGenerateReport, getAttachmentClassifier, getDependencySourcePaths, getFiles, getJavadocOptionsFile, getOutputDirectory, getProject, getSourcePaths

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

AggregatorTestJavadocReport

public AggregatorTestJavadocReport()

Method Detail

isAggregator

protected boolean isAggregator()

Indicates whether this goal is flagged with @aggregator.

Overrides:

isAggregator in class JavadocReport

Returns:

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

See Also:

AggregatorJavadocReport, AggregatorTestJavadocReport