org.apache.maven.plugin.javadoc
Class JavadocJar
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugin.javadoc.AbstractJavadocMojo
org.apache.maven.plugin.javadoc.JavadocJar
- All Implemented Interfaces:
- org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
- Direct Known Subclasses:
- AggregatorJavadocJar, TestJavadocJar
public class JavadocJar
- extends AbstractJavadocMojo
Bundles the Javadoc documentation for main Java code
in an NON aggregator project into
a jar using the standard Javadoc Tool.
- Since:
- 2.0
- Version:
- $Id: JavadocJar.html 829396 2012-08-19 17:35:19Z hboutemy $
- Is defined by the goal name:
- jar
- Is bound to the specified phase of the standard build lifecycle:
- package
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 |
Methods inherited from class org.apache.maven.plugin.javadoc.AbstractJavadocMojo |
buildJavadocOptions, canGenerateReport, configureDependencySourceResolution, executeReport, getAttachmentClassifier, getCompileArtifacts, getDependencySourcePaths, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocDirectory, getJavadocOptionsFile, getOutputDirectory, getOverview, getProject, getProjectArtifacts, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getWindowtitle, isAggregator |
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 |
JavadocJar
public JavadocJar()
execute
public void execute()
throws org.apache.maven.plugin.MojoExecutionException
-
- Throws:
org.apache.maven.plugin.MojoExecutionException
getClassifier
protected String getClassifier()
- Returns:
- the wanted classifier, i.e.
javadoc
or test-javadoc
Copyright © 2004-2010 The Apache Software Foundation. All Rights Reserved.