org.apache.maven.plugin.javadoc
Class AggregatorJavadocReport

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.AggregatorJavadocReport

All Implemented Interfaces:

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

public class AggregatorJavadocReport
extends JavadocReport

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

Since:

2.5

Version:

$Id: AggregatorJavadocReport.html 829389 2012-08-19 17:23:07Z hboutemy $

Author:

Vincent Siveton

Aggregates the Maven project and its child modules.

Is defined by the goal name:

aggregate

Field Summary

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

aggregate, ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, failOnError, FILES_FILE_NAME, links, OPTIONS_FILE_NAME, outputDirectory, PACKAGES_FILE_NAME, project, skip, 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

AggregatorJavadocReport()

Method Summary

protected boolean

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

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

canGenerateReport, execute, generate, getCategoryName, getDescription, getName, getOutputName, getReportOutputDirectory, isExternalReport, setReportOutputDirectory

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

AggregatorJavadocReport

public AggregatorJavadocReport()

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