@Mojo(name="test-jar", defaultPhase=PACKAGE, requiresDependencyResolution=TEST, threadSafe=true) public class TestJavadocJar extends JavadocJar
test Java code
in an NON aggregator project into
a jar using the standard Javadoc Tool.Modifier and Type | Field and Description |
---|---|
private java.io.File |
outputDirectory
Specifies the destination directory where Javadoc saves the generated HTML files.
|
private java.lang.String |
testClassifier |
private java.lang.String |
testDoctitle
Specifies the Test title to be placed near the top of the overview summary file.
|
private java.io.File |
testJavadocDirectory
Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e.
|
private java.io.File |
testOverview
Specifies that Javadoc should retrieve the text for the Test overview documentation from the "source" file
specified by path/filename and place it on the Overview page (overview-summary.html).
|
private java.lang.String |
testWindowtitle
Specifies the Test title to be placed in the HTML title tag.
|
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 and Description |
---|
TestJavadocJar() |
Modifier and Type | Method and 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 the
Java Test code . |
doExecute
buildJavadocOptions, canGenerateReport, collect, execute, executeReport, failOnError, getAttachmentClassifier, getDependencySourcePaths, getDoclint, getFiles, getJavadocOptionsFile, getProject, getSourcePaths, getToolchain, isAggregator, isValidJavadocLink, logError, resolveDependency, verifyRemovedParameter
@Parameter(defaultValue="${project.build.directory}/testapidocs", required=true) private java.io.File outputDirectory
@Parameter(property="testDoctitle", alias="doctitle", defaultValue="${project.name} ${project.version} Test API") private java.lang.String testDoctitle
@Parameter(property="testOverview", alias="overview", defaultValue="${basedir}/src/test/javadoc/overview.html") private java.io.File testOverview
@Parameter(property="testWindowtitle", alias="windowtitle", defaultValue="${project.name} ${project.version} Test API") private java.lang.String testWindowtitle
@Parameter(alias="javadocDirectory", defaultValue="${basedir}/src/test/javadoc") private java.io.File testJavadocDirectory
@Parameter(property="maven.javadoc.testClassifier", defaultValue="test-javadoc", required=true) private java.lang.String testClassifier
protected java.lang.String getClassifier()
getClassifier
in class JavadocJar
javadoc
or test-javadoc
protected java.lang.String getOutputDirectory()
getOutputDirectory
in class AbstractJavadocMojo
protected java.io.File getJavadocDirectory()
getJavadocDirectory
in class AbstractJavadocMojo
protected java.lang.String getDoctitle()
getDoctitle
in class AbstractJavadocMojo
protected java.io.File getOverview()
getOverview
in class AbstractJavadocMojo
javadocdirectory
protected java.lang.String getWindowtitle()
getWindowtitle
in class AbstractJavadocMojo
protected java.util.List<java.io.File> getProjectBuildOutputDirs(org.apache.maven.project.MavenProject p)
getProjectBuildOutputDirs
in class AbstractJavadocMojo
p
- not null maven projectprotected java.util.List<java.lang.String> getProjectSourceRoots(org.apache.maven.project.MavenProject p)
getProjectSourceRoots
in class AbstractJavadocMojo
p
- not null maven projectprotected java.util.List<java.lang.String> getExecutionProjectSourceRoots(org.apache.maven.project.MavenProject p)
getExecutionProjectSourceRoots
in class AbstractJavadocMojo
p
- not null maven projectprotected org.apache.maven.shared.artifact.filter.resolve.ScopeFilter getDependencyScopeFilter()
getDependencyScopeFilter
in class AbstractJavadocMojo
protected SourceResolverConfig configureDependencySourceResolution(SourceResolverConfig config)
configureDependencySourceResolution
in class AbstractJavadocMojo
config
- SourceResolverConfig
SourceResolverConfig
protected boolean isTest()
AbstractJavadocMojo
Java Test code
.isTest
in class AbstractJavadocMojo
true
if the goal generates Test Javadocs, false
otherwise.