Class 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 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.
      • 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.