org.apache.maven.plugins.javadoc

Class TestResourcesBundleMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.javadoc.AbstractJavadocMojo

org.apache.maven.plugins.javadoc.ResourcesBundleMojo

org.apache.maven.plugins.javadoc.TestResourcesBundleMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="test-resource-bundle",
      defaultPhase=PACKAGE,
      requiresDependencyResolution=TEST,
      threadSafe=true)
public class TestResourcesBundleMojo
extends ResourcesBundleMojo

Bundle TestJavadocJar.testJavadocDirectory, along with javadoc configuration options from AbstractJavadocMojo such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself.

Since:

2.7

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	testJavadocDirectory Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e.

Fields inherited from class org.apache.maven.plugins.javadoc.ResourcesBundleMojo

BUNDLE_OPTIONS_PATH, RESOURCES_DIR_PATH

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, outputDirectory, PACKAGES_FILE_NAME, project, session, skip, TEST_JAVADOC_RESOURCES_ATTACHMENT_CLASSIFIER, useStandardDocletOptions

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
TestResourcesBundleMojo()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getAttachmentClassifier() Override this if you need to provide a bundle attachment classifier, as in the case of test javadocs.
protected java.io.File	getJavadocDirectory()
protected boolean	isTest() Indicates whether this goal generates documentation for the Java Test code.

Methods inherited from class org.apache.maven.plugins.javadoc.ResourcesBundleMojo

doExecute

Methods inherited from class org.apache.maven.plugins.javadoc.AbstractJavadocMojo

buildJavadocOptions, canGenerateReport, collect, configureDependencySourceResolution, execute, executeReport, failOnError, getDependencyScopeFilter, getDependencySourcePaths, getDoclint, getDoctitle, getExecutionProjectSourceRoots, getFiles, getJavadocOptionsFile, getOutputDirectory, getOverview, getProject, getProjectBuildOutputDirs, getProjectSourceRoots, getSourcePaths, getToolchain, getWindowtitle, isAggregator, isValidJavadocLink, logError, resolveDependency, verifyRemovedParameter

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

Field Detail

testJavadocDirectory

@Parameter(alias="javadocDirectory",
           defaultValue="${basedir}/src/test/javadoc")
private java.io.File testJavadocDirectory

Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).

Constructor Detail

TestResourcesBundleMojo

public TestResourcesBundleMojo()

Method Detail

getAttachmentClassifier

protected java.lang.String getAttachmentClassifier()

Description copied from class: AbstractJavadocMojo

Override this if you need to provide a bundle attachment classifier, as in the case of test javadocs.

Overrides:

getAttachmentClassifier in class AbstractJavadocMojo

Returns:

The attachment classifier.

getJavadocDirectory

protected java.io.File getJavadocDirectory()

Overrides:

getJavadocDirectory in class AbstractJavadocMojo

Returns:

the current javadoc directory

isTest

protected boolean isTest()

Description copied from class: AbstractJavadocMojo

Indicates whether this goal generates documentation for the Java Test code.

Overrides:

isTest in class AbstractJavadocMojo

Returns:

true if the goal generates Test Javadocs, false otherwise.