Package org.apache.maven.plugins.javadoc
Class JavadocJar
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugins.javadoc.AbstractJavadocMojo
org.apache.maven.plugins.javadoc.JavadocJar
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
- Direct Known Subclasses:
AggregatorJavadocJar
,TestJavadocJar
@Mojo(name="jar",
defaultPhase=PACKAGE,
requiresDependencyResolution=COMPILE,
threadSafe=true)
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
-
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.plugin.Mojo
ROLE
-
Constructor Summary
-
Method Summary
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, isAggregator, isSkippedJavadoc, isSkippedModule, isTest, isValidJavadocLink, logError, resolveDependency, verifyRemovedParameter
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Constructor Details
-
JavadocJar
public JavadocJar()
-
-
Method Details
-
doExecute
public void doExecute() throws org.apache.maven.plugin.MojoExecutionException- Throws:
org.apache.maven.plugin.MojoExecutionException
-
getClassifier
- Returns:
- the wanted classifier, i.e.
javadoc
ortest-javadoc
-