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, OPTIONS_FILE_NAME, outputDirectory, outputTimestamp, PACKAGES_FILE_NAME, project, session, 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
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
Indicates whether this goal is flagged with@aggregator
.Methods inherited from class org.apache.maven.plugins.javadoc.JavadocReport
canGenerateReport, doExecute, generate, generate, generate, getCategoryName, getDescription, getName, getOutputName, getReportOutputDirectory, isExternalReport, setDestDir, 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, getSourcePaths, getToolchain, getWindowtitle, isSkippedJavadoc, isSkippedModule, isTest, isValidJavadocLink, logError, resolveDependency, verifyRemovedParameter
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Constructor Details
-
AggregatorJavadocReport
public AggregatorJavadocReport()
-
-
Method Details
-
isAggregator
protected boolean isAggregator()Description copied from class:AbstractJavadocMojo
Indicates whether this goal is flagged with@aggregator
.- Overrides:
isAggregator
in classAbstractJavadocMojo
- Returns:
true
if the goal is designed as an aggregator,false
otherwise.- See Also:
-