Class GroovyDocTestsMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    Direct Known Subclasses:
    GroovyDocTestsJarMojo

    @Mojo(name="groovydocTests",
          requiresDependencyResolution=TEST,
          threadSafe=true)
    public class GroovyDocTestsMojo
    extends AbstractGroovyDocMojo
    Generates GroovyDoc for the test sources.
    Since:
    1.0-beta-1
    Author:
    Keegan Witt
    • Field Detail

      • testSources

        @Parameter
        protected org.apache.maven.shared.model.fileset.FileSet[] testSources
        The Groovy test source files (relative paths). Default: "${project.basedir}/src/test/groovy/**/*.groovy"
      • testGroovyDocOutputDirectory

        @Parameter(defaultValue="${project.build.directory}/testgapidocs")
        protected File testGroovyDocOutputDirectory
        The location for the generated test API docs.
      • testGroovyDocJavaSources

        @Parameter(defaultValue="true")
        protected boolean testGroovyDocJavaSources
        Whether to include test Java sources in GroovyDoc generation.
        Since:
        1.7
    • Constructor Detail

      • GroovyDocTestsMojo

        public GroovyDocTestsMojo()
    • Method Detail

      • execute

        public void execute()
                     throws org.apache.maven.plugin.MojoExecutionException
        Executes this mojo.
        Throws:
        org.apache.maven.plugin.MojoExecutionException - If an unexpected problem occurs (causes a "BUILD ERROR" message to be displayed)