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:
- ContextEnabled, Mojo, MavenReport
@Mojo(name="aggregate",
aggregator=true,
requiresDependencyResolution=COMPILE)
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.java 1385191 2012-09-15 22:04:49Z hboutemy $
- Author:
- Vincent Siveton
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.plugin.Mojo |
ROLE |
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, setDestDir, setReportOutputDirectory |
Methods inherited from class org.apache.maven.plugin.javadoc.AbstractJavadocMojo |
buildJavadocOptions, canGenerateReport, configureDependencySourceResolution, executeReport, failOnError, getAttachmentClassifier, getCompileArtifacts, getDependencySourcePaths, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getJavadocOptionsFile, getOutputDirectory, getOverview, getProject, getProjectArtifacts, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getWindowtitle, logError, resolveDependency |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
AggregatorJavadocReport
public AggregatorJavadocReport()
isAggregator
protected boolean isAggregator()
- Description copied from class:
AbstractJavadocMojo
- 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
Copyright © 2004-2012 The Apache Software Foundation. All Rights Reserved.