Package org.apache.maven.plugins.javadoc
Class TestJavadocJar
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- org.apache.maven.plugins.javadoc.AbstractJavadocMojo
-
- org.apache.maven.plugins.javadoc.JavadocJar
-
- org.apache.maven.plugins.javadoc.TestJavadocJar
-
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
- Direct Known Subclasses:
AggregatorTestJavadocJar
@Mojo(name="test-jar", defaultPhase=PACKAGE, requiresDependencyResolution=TEST, threadSafe=true) public class TestJavadocJar extends JavadocJar
Bundles the Javadoc documentation fortest Java code
in an NON aggregator project into a jar using the standard Javadoc Tool.- Since:
- 2.5
- Version:
- $Id: TestJavadocJar.java 1747985 2016-06-12 12:04:55Z rfscholte $
- Author:
- Vincent Siveton
-
-
Field Summary
-
Fields inherited from class org.apache.maven.plugins.javadoc.AbstractJavadocMojo
ARGFILE_FILE_NAME, DEBUG_JAVADOC_SCRIPT_NAME, DEFAULT_JAVA_API_LINKS, failOnError, failOnWarnings, FILES_FILE_NAME, JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, links, OPTIONS_FILE_NAME, PACKAGES_FILE_NAME, project, session, skip, TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, useStandardDocletOptions
-
-
Constructor Summary
Constructors Constructor Description TestJavadocJar()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected SourceResolverConfig
configureDependencySourceResolution(SourceResolverConfig config)
Overriden to enable the resolution of -test-sources jar files.protected java.lang.String
getClassifier()
protected org.apache.maven.shared.artifact.filter.resolve.ScopeFilter
getDependencyScopeFilter()
protected java.lang.String
getDoctitle()
protected java.util.List<java.lang.String>
getExecutionProjectSourceRoots(org.apache.maven.project.MavenProject p)
protected java.io.File
getJavadocDirectory()
protected java.lang.String
getOutputDirectory()
protected java.io.File
getOverview()
protected java.util.List<java.io.File>
getProjectBuildOutputDirs(org.apache.maven.project.MavenProject p)
protected java.util.List<java.lang.String>
getProjectSourceRoots(org.apache.maven.project.MavenProject p)
protected java.lang.String
getWindowtitle()
protected boolean
isTest()
Indicates whether this goal generates documentation for theJava Test code
.-
Methods inherited from class org.apache.maven.plugins.javadoc.JavadocJar
doExecute
-
Methods inherited from class org.apache.maven.plugins.javadoc.AbstractJavadocMojo
buildJavadocOptions, canGenerateReport, collect, execute, executeReport, failOnError, getAttachmentClassifier, getDependencySourcePaths, getDoclint, getFiles, getJavadocOptionsFile, getProject, getSourcePaths, getToolchain, isAggregator, isValidJavadocLink, logError, resolveDependency, verifyRemovedParameter
-
-
-
-
Method Detail
-
getClassifier
protected java.lang.String getClassifier()
- Overrides:
getClassifier
in classJavadocJar
- Returns:
- the wanted classifier, i.e.
javadoc
ortest-javadoc
-
getOutputDirectory
protected java.lang.String getOutputDirectory()
- Overrides:
getOutputDirectory
in classAbstractJavadocMojo
- Returns:
- the output directory
-
getJavadocDirectory
protected java.io.File getJavadocDirectory()
- Overrides:
getJavadocDirectory
in classAbstractJavadocMojo
- Returns:
- the current javadoc directory
-
getDoctitle
protected java.lang.String getDoctitle()
- Overrides:
getDoctitle
in classAbstractJavadocMojo
- Returns:
- the title to be placed near the top of the overview summary file
-
getOverview
protected java.io.File getOverview()
- Overrides:
getOverview
in classAbstractJavadocMojo
- Returns:
- the overview documentation file from the user parameter or from the
javadocdirectory
-
getWindowtitle
protected java.lang.String getWindowtitle()
- Overrides:
getWindowtitle
in classAbstractJavadocMojo
- Returns:
- the title to be placed in the HTML title tag
-
getProjectBuildOutputDirs
protected java.util.List<java.io.File> getProjectBuildOutputDirs(org.apache.maven.project.MavenProject p)
- Overrides:
getProjectBuildOutputDirs
in classAbstractJavadocMojo
- Parameters:
p
- not null maven project- Returns:
- the list of directories where compiled classes are placed for the given project. These dirs are added in the javadoc classpath.
-
getProjectSourceRoots
protected java.util.List<java.lang.String> getProjectSourceRoots(org.apache.maven.project.MavenProject p)
- Overrides:
getProjectSourceRoots
in classAbstractJavadocMojo
- Parameters:
p
- not null maven project- Returns:
- the list of source paths for the given project
-
getExecutionProjectSourceRoots
protected java.util.List<java.lang.String> getExecutionProjectSourceRoots(org.apache.maven.project.MavenProject p)
- Overrides:
getExecutionProjectSourceRoots
in classAbstractJavadocMojo
- Parameters:
p
- not null maven project- Returns:
- the list of source paths for the execution project of the given project
-
getDependencyScopeFilter
protected org.apache.maven.shared.artifact.filter.resolve.ScopeFilter getDependencyScopeFilter()
- Overrides:
getDependencyScopeFilter
in classAbstractJavadocMojo
-
configureDependencySourceResolution
protected SourceResolverConfig configureDependencySourceResolution(SourceResolverConfig config)
Overriden to enable the resolution of -test-sources jar files. Override this method to customize the configuration for resolving dependency sources. The default behavior enables the resolution of -sources jar files.- Overrides:
configureDependencySourceResolution
in classAbstractJavadocMojo
- Parameters:
config
-SourceResolverConfig
- Returns:
SourceResolverConfig
-
isTest
protected boolean isTest()
Description copied from class:AbstractJavadocMojo
Indicates whether this goal generates documentation for theJava Test code
.- Overrides:
isTest
in classAbstractJavadocMojo
- Returns:
true
if the goal generates Test Javadocs,false
otherwise.
-
-