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.MavenReport
@Mojo(name="aggregate", aggregator=true, requiresDependencyResolution=COMPILE) @Execute(phase=COMPILE) public class AggregatorJavadocReport extends JavadocReport
Generates documentation for theJava code
in an aggregator project using the standard Javadoc Tool.- Since:
- 2.5
- Version:
- $Id: AggregatorJavadocReport.java 1749408 2016-06-20 22:54:15Z schulte $
- Author:
- Vincent Siveton
-
-
Field Summary
-
Fields inherited from class org.apache.maven.plugins.javadoc.AbstractJavadocMojo
ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, DEFAULT_JAVA_API_LINKS, failOnError, failOnWarnings, FILES_FILE_NAME, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, OPTIONS_FILE_NAME, outputDirectory, PACKAGES_FILE_NAME, project, session, skip, TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, useStandardDocletOptions
-
-
Constructor Summary
Constructors Constructor Description AggregatorJavadocReport()
-
Method Summary
All Methods Instance Methods Concrete Methods 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, getCategoryName, getDescription, getName, getOutputName, getReportOutputDirectory, isExternalReport, setDestDir, setReportOutputDirectory
-
Methods inherited from class org.apache.maven.plugins.javadoc.AbstractJavadocMojo
buildJavadocOptions, canGenerateReport, collect, configureDependencySourceResolution, execute, executeReport, failOnError, getAttachmentClassifier, getDependencyScopeFilter, getDependencySourcePaths, getDoclint, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getJavadocOptionsFile, getOutputDirectory, getOverview, getProject, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getToolchain, getWindowtitle, isTest, isValidJavadocLink, logError, resolveDependency, verifyRemovedParameter
-
-
-
-
Method Detail
-
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:
AggregatorJavadocReport
,AggregatorTestJavadocReport
-
-