Package org.apache.maven.plugins.javadoc
Class JavadocJarMojo
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- org.apache.maven.plugins.javadoc.AbstractJavadocMojo
-
- org.apache.maven.plugins.javadoc.JavadocJarMojo
-
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
- Direct Known Subclasses:
AggregatorJavadocJarMojo
,TestJavadocJarMojo
@Mojo(name="jar", defaultPhase=PACKAGE, requiresDependencyResolution=COMPILE, threadSafe=true) public class JavadocJarMojo extends AbstractJavadocMojo
Bundles the Javadoc documentation formain 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, mojoExecution, OPTIONS_FILE_NAME, outputDirectory, outputTimestamp, PACKAGES_FILE_NAME, project, reactorProjects, session, siteTool, skip, TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, useStandardDocletOptions
-
-
Constructor Summary
Constructors Constructor Description JavadocJarMojo(org.apache.maven.project.MavenProjectHelper projectHelper, org.codehaus.plexus.archiver.jar.JarArchiver jarArchiver, org.apache.maven.doxia.tools.SiteTool siteTool, org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager, ResourceResolver resourceResolver, org.eclipse.aether.RepositorySystem repoSystem, org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager, org.apache.maven.project.ProjectBuilder mavenProjectBuilder, org.apache.maven.toolchain.ToolchainManager toolchainManager)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
doExecute()
protected String
getClassifier()
-
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, getPluginReportOutputDirectory, getProject, getProjectBuildOutputDirs, getProjectSourceRoots, getReactorProjects, getSourcePaths, getToolchain, getWindowtitle, isAggregator, isSkippedJavadoc, isSkippedModule, isTest, isValidJavadocLink, logError, resolveDependency, verifyRemovedParameter
-
-
-
-
Constructor Detail
-
JavadocJarMojo
@Inject public JavadocJarMojo(org.apache.maven.project.MavenProjectHelper projectHelper, org.codehaus.plexus.archiver.jar.JarArchiver jarArchiver, org.apache.maven.doxia.tools.SiteTool siteTool, org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager, ResourceResolver resourceResolver, org.eclipse.aether.RepositorySystem repoSystem, org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManager, org.apache.maven.project.ProjectBuilder mavenProjectBuilder, org.apache.maven.toolchain.ToolchainManager toolchainManager)
-
-
Method Detail
-
doExecute
protected void doExecute() throws org.apache.maven.plugin.MojoExecutionException
- Specified by:
doExecute
in classAbstractJavadocMojo
- Throws:
org.apache.maven.plugin.MojoExecutionException
-
getClassifier
protected String getClassifier()
- Returns:
- the wanted classifier, i.e.
javadoc
ortest-javadoc
-
-