@Mojo(name="test-resource-bundle", defaultPhase=PACKAGE, requiresDependencyResolution=TEST, threadSafe=true) public class TestResourcesBundleMojo extends ResourcesBundleMojo
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.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.
|
BUNDLE_OPTIONS_PATH, RESOURCES_DIR_PATH
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
Constructor and Description |
---|
TestResourcesBundleMojo() |
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 . |
doExecute
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
@Parameter(alias="javadocDirectory", defaultValue="${basedir}/src/test/javadoc") private java.io.File testJavadocDirectory
protected java.lang.String getAttachmentClassifier()
AbstractJavadocMojo
getAttachmentClassifier
in class AbstractJavadocMojo
protected java.io.File getJavadocDirectory()
getJavadocDirectory
in class AbstractJavadocMojo
protected boolean isTest()
AbstractJavadocMojo
Java Test code
.isTest
in class AbstractJavadocMojo
true
if the goal generates Test Javadocs, false
otherwise.