Class GroovyDocMojo

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

    @Mojo(name="groovydoc",
          requiresDependencyResolution=RUNTIME,
          threadSafe=true)
    public class GroovyDocMojo
    extends AbstractGroovyDocMojo
    Generates GroovyDoc for the main sources.
    Since:
    1.0-beta-1
    • Field Detail

      • sources

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

        @Parameter(defaultValue="${project.build.directory}/gapidocs")
        protected java.io.File groovyDocOutputDirectory
        The location for the generated API docs.
      • groovyDocJavaSources

        @Parameter(defaultValue="true")
        protected boolean groovyDocJavaSources
        Whether to include Java sources in GroovyDoc generation.
        Since:
        1.0-beta-2
    • Constructor Detail

      • GroovyDocMojo

        public GroovyDocMojo()
    • 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)