Package org.apache.maven.plugins.javadoc

Class AggregatorJavadocReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.javadoc.AbstractJavadocMojo

org.apache.maven.plugins.javadoc.JavadocReport

org.apache.maven.plugins.javadoc.AggregatorJavadocReport

All Implemented Interfaces:

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

Direct Known Subclasses:

AggregatorJavadocNoForkReport

@Mojo(name="aggregate",
      aggregator=true,
      requiresDependencyResolution=COMPILE)
@Execute(phase=COMPILE)
public class AggregatorJavadocReport
extends JavadocReport

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

Since version 3.1.0 an aggregated report is created for every module of a Maven multimodule project.

Since:

2.5

Author:

Vincent Siveton

Field Summary

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

ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, failOnError, failOnWarnings, FILES_FILE_NAME, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, mojoExecution, OPTIONS_FILE_NAME, outputDirectory, outputTimestamp, PACKAGES_FILE_NAME, project, reactorProjects, session, siteTool, 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

Constructors

Constructor	Description
AggregatorJavadocReport()

Method Summary

Modifier and Type	Method	Description
protected boolean	isAggregator()	Indicates whether this goal is flagged with @aggregator.

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

canGenerateReport, doExecute, generate, generate, getCategoryName, getDescription, getName, getOutputName, getPluginReportOutputDirectory, getReportOutputDirectory, isExternalReport, setReportOutputDirectory

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

buildJavadocOptions, canGenerateReport, configureDependencySourceResolution, execute, executeReport, failOnError, getAttachmentClassifier, getClassesFile, getDefaultJavadocApiLink, getDependencyScopeFilter, getDependencySourcePaths, getDoclint, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getJavadocOptionsFile, getOutputDirectory, getOverview, getProject, getProjectBuildOutputDirs, getProjectSourceRoots, getReactorProjects, getSourcePaths, getToolchain, getWindowtitle, isSkippedJavadoc, isSkippedModule, isTest, isValidJavadocLink, logError, resolveDependency, verifyRemovedParameter

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

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

getOutputPath

Constructor Detail

AggregatorJavadocReport

public AggregatorJavadocReport()

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