org.apache.maven.plugin.javadoc
Class AggregatorJavadocJar

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.plugin.javadoc.AbstractJavadocMojo
          extended by org.apache.maven.plugin.javadoc.JavadocJar
              extended by org.apache.maven.plugin.javadoc.AggregatorJavadocJar
All Implemented Interfaces:
ContextEnabled, Mojo

@Mojo(name="aggregate-jar",
      defaultPhase=PACKAGE,
      aggregator=true,
      requiresDependencyResolution=COMPILE)
public class AggregatorJavadocJar
extends JavadocJar

Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.

Since:
2.6
Version:
$Id: AggregatorJavadocJar.html 922314 2014-09-15 20:18:14Z dennisl $

Field Summary
 
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, session, skip, TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, useStandardDocletOptions
 
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
 
Constructor Summary
AggregatorJavadocJar()
           
 
Method Summary
protected  boolean isAggregator()
          Indicates whether this goal is flagged with @aggregator.
 
Methods inherited from class org.apache.maven.plugin.javadoc.JavadocJar
execute, getClassifier
 
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 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

AggregatorJavadocJar

public AggregatorJavadocJar()
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


Copyright © 2004–2014 The Apache Software Foundation. All rights reserved.