Package org.codehaus.gmavenplus.mojo

Class AbstractGroovyDocMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.codehaus.gmavenplus.mojo.AbstractGroovyMojo
org.codehaus.gmavenplus.mojo.AbstractGroovySourcesMojo
org.codehaus.gmavenplus.mojo.AbstractGroovyDocMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
Direct Known Subclasses:
GroovyDocMojo, GroovyDocTestsMojo
public abstract class AbstractGroovyDocMojo extends AbstractGroovySourcesMojo
The base GroovyDoc mojo, which all GroovyDoc mojos extend.
Author:
Keegan Witt

  • Field Details

    • GROOVY_1_6_0_RC1

      protected static final Version GROOVY_1_6_0_RC1
      Groovy 1.6.0 RC-1 version.

    • GROOVY_1_5_8

      protected static final Version GROOVY_1_5_8
      Groovy 1.5.8 version.

    • windowTitle

      @Parameter(defaultValue="Groovy Documentation") protected String windowTitle
      The window title.

    • docTitle

      @Parameter(defaultValue="Groovy Documentation") protected String docTitle
      The page title.

    • languageLevel

      @Parameter protected LanguageLevel languageLevel
      The Java language level to use for GroovyDoc generation.

    • displayAuthor

      @Parameter(defaultValue="true") protected boolean displayAuthor
      Whether to display the author in the generated GroovyDoc.

    • overviewFile

      @Parameter protected File overviewFile
      The HTML file to be used for overview documentation.

    • stylesheetFile

      @Parameter protected File stylesheetFile
      The stylesheet file (absolute path) to copy to output directory (will overwrite default stylesheet.css).

    • stylesheetEncoding

      @Parameter(defaultValue="${project.build.sourceEncoding}") protected String stylesheetEncoding
      The encoding of stylesheetFile.

    • scope

      @Parameter(defaultValue="private") protected String scope
      The scope to generate GroovyDoc for. Should be one of:
      • "public"
      • "protected"
      • "package"
      • "private"

    • skipGroovyDoc

      @Parameter(property="skipGroovydoc", defaultValue="false") protected boolean skipGroovyDoc
      Flag to allow GroovyDoc generation to be skipped.
      Since:
      1.6

    • includeClasspath

      @Parameter(defaultValue="PROJECT_ONLY") protected IncludeClasspath includeClasspath
      What classpath to include. One of
      • PROJECT_ONLY
      • PROJECT_AND_PLUGIN
      • PLUGIN_ONLY
      Uses the same scope as the required dependency resolution of this mojo. Use only if you know what you're doing.
      Since:
      1.8.0

    • defaultDocTemplates

      @Parameter protected String[] defaultDocTemplates
      Override the default Groovydoc default top-level templates. Uses Groovy's standard templates by default.
      Since:
      1.10.1

    • defaultPackageTemplates

      @Parameter protected String[] defaultPackageTemplates
      Override the default Groovydoc package-level templates. Uses Groovy's standard templates by default.
      Since:
      1.10.1

    • defaultClassTemplates

      @Parameter protected String[] defaultClassTemplates
      Override the default Groovydoc class-level templates. Uses Groovy's standard templates by default.
      Since:
      1.10.1

    • groovyDocToolClass

      @Parameter protected String groovyDocToolClass
      Allows you to override the class that is normally org.codehaus.groovy.tools.groovydoc.GroovyDocTool, for use when creating custom GroovyDoc implementations.
      Since:
      1.10.1

    • outputToolClass

      @Parameter protected String outputToolClass
      Allows you to override the class that is normally org.codehaus.groovy.tools.groovydoc.OutputTool, for use when creating custom GroovyDoc implementations.
      Since:
      1.10.1

    • fileOutputToolClass

      @Parameter protected String fileOutputToolClass
      Allows you to override the class that is normally org.codehaus.groovy.tools.groovydoc.FileOutputTool, for use when creating custom GroovyDoc implementations.
      Since:
      1.10.1

    • resourceManagerClass

      @Parameter protected String resourceManagerClass
      Allows you to override the class that is normally org.codehaus.groovy.tools.groovydoc.ResourceManager, for use when creating custom GroovyDoc implementations.
      Since:
      1.10.1

    • classpathResourceManagerClass

      @Parameter protected String classpathResourceManagerClass
      Allows you to override the class that is normally org.codehaus.groovy.tools.groovydoc.ClasspathResourceManager, for use when creating custom GroovyDoc implementations.
      Since:
      1.10.1

    • linkArgumentClass

      @Parameter protected String linkArgumentClass
      Allows you to override the class that is normally org.codehaus.groovy.tools.groovydoc.LinkArgument (or org.codehaus.groovy.ant.Groovydoc$LinkArgument for Groovy older than 1.6-RC-2), for use when creating custom GroovyDoc implementations.
      Since:
      1.10.1

    • attachGroovyDocAnnotation

      @Parameter(defaultValue="false") protected boolean attachGroovyDocAnnotation
      Enable attaching GroovyDoc annotation. Requires Groovy 3.0.0 alpha-4 or newer.
      Since:
      1.11.0

    • toolchainManager

      @Inject protected org.apache.maven.toolchain.ToolchainManager toolchainManager
      The Maven ToolchainManager.

    • session

      @Parameter(defaultValue="${session}", readonly=true, required=true) protected org.apache.maven.execution.MavenSession session
      The Maven Session.

    • fork

      @Parameter(property="fork", defaultValue="false") protected boolean fork
      Whether to execute in a forked process.
      Since:
      4.3.0

  • Constructor Details

    • AbstractGroovyDocMojo

      public AbstractGroovyDocMojo()

  • Method Details