Fork me on GitHub
Built by Maven

gplus:groovydoc

Full name:

org.codehaus.gmavenplus:gmavenplus-plugin:4.0.1:groovydoc

Description:

Generates GroovyDoc for the main sources.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.0-beta-1.

Optional Parameters

Name Type Since Description
<attachGroovyDocAnnotation> boolean 1.11.0 Enable attaching GroovyDoc annotation. Requires Groovy 3.0.0 alpha-4 or newer.
Default: false
<classpathResourceManagerClass> String 1.10.1 Allows you to override the class that is normally org.codehaus.groovy.tools.groovydoc.ClasspathResourceManager, for use when creating custom GroovyDoc implementations.
<defaultClassTemplates> String[] 1.10.1 Override the default Groovydoc class-level templates. Uses Groovy's standard templates by default.
<defaultDocTemplates> String[] 1.10.1 Override the default Groovydoc default top-level templates. Uses Groovy's standard templates by default.
<defaultPackageTemplates> String[] 1.10.1 Override the default Groovydoc package-level templates. Uses Groovy's standard templates by default.
<displayAuthor> boolean - Whether to display the author in the generated GroovyDoc.
Default: true
<docTitle> String - The page title.
Default: Groovy Documentation
<fileOutputToolClass> String 1.10.1 Allows you to override the class that is normally org.codehaus.groovy.tools.groovydoc.FileOutputTool, for use when creating custom GroovyDoc implementations.
<footer> String - The page footer.
Default: Groovy Documentation
<groovyDocJavaSources> boolean 1.0-beta-2 Whether to include Java sources in GroovyDoc generation.
Default: true
<groovyDocOutputDirectory> File - The location for the generated API docs.
Default: ${project.build.directory}/gapidocs
<groovyDocToolClass> String 1.10.1 Allows you to override the class that is normally org.codehaus.groovy.tools.groovydoc.GroovyDocTool, for use when creating custom GroovyDoc implementations.
<header> String - The page header.
Default: Groovy Documentation
<includeClasspath> IncludeClasspath 1.8.0 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.
Default: PROJECT_ONLY
<linkArgumentClass> String 1.10.1 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.
<links> List<Link> 1.0-beta-2 Links to include in the generated GroovyDoc (key is link href, value is comma-separated packages to use that link).
<outputToolClass> String 1.10.1 Allows you to override the class that is normally org.codehaus.groovy.tools.groovydoc.OutputTool, for use when creating custom GroovyDoc implementations.
<overviewFile> File - The HTML file to be used for overview documentation.
<resourceManagerClass> String 1.10.1 Allows you to override the class that is normally org.codehaus.groovy.tools.groovydoc.ResourceManager, for use when creating custom GroovyDoc implementations.
<scope> String - The scope to generate GroovyDoc for. Should be one of:
  • "public"
  • "protected"
  • "package"
  • "private"

Default: private
<skipGroovyDoc> boolean 1.6 Flag to allow GroovyDoc generation to be skipped.
Default: false
User Property: skipGroovydoc
<sources> FileSet[] - The Groovy source files (relative paths). Default: "${project.basedir}/src/main/groovy/**/*.groovy"
<stylesheetEncoding> String - The encoding of stylesheetFile.
Default: ${project.build.sourceEncoding}
<stylesheetFile> File - The stylesheet file (absolute path) to copy to output directory (will overwrite default stylesheet.css).
<windowTitle> String - The window title.
Default: Groovy Documentation

Parameter Details

<attachGroovyDocAnnotation>

Enable attaching GroovyDoc annotation. Requires Groovy 3.0.0 alpha-4 or newer.
  • Type: boolean
  • Since: 1.11.0
  • Required: No
  • Default: false

<classpathResourceManagerClass>

Allows you to override the class that is normally org.codehaus.groovy.tools.groovydoc.ClasspathResourceManager, for use when creating custom GroovyDoc implementations.
  • Type: java.lang.String
  • Since: 1.10.1
  • Required: No

<defaultClassTemplates>

Override the default Groovydoc class-level templates. Uses Groovy's standard templates by default.
  • Type: java.lang.String[]
  • Since: 1.10.1
  • Required: No

<defaultDocTemplates>

Override the default Groovydoc default top-level templates. Uses Groovy's standard templates by default.
  • Type: java.lang.String[]
  • Since: 1.10.1
  • Required: No

<defaultPackageTemplates>

Override the default Groovydoc package-level templates. Uses Groovy's standard templates by default.
  • Type: java.lang.String[]
  • Since: 1.10.1
  • Required: No

<displayAuthor>

Whether to display the author in the generated GroovyDoc.
  • Type: boolean
  • Required: No
  • Default: true

<docTitle>

The page title.
  • Type: java.lang.String
  • Required: No
  • Default: Groovy Documentation

<fileOutputToolClass>

Allows you to override the class that is normally org.codehaus.groovy.tools.groovydoc.FileOutputTool, for use when creating custom GroovyDoc implementations.
  • Type: java.lang.String
  • Since: 1.10.1
  • Required: No

<footer>

The page footer.
  • Type: java.lang.String
  • Required: No
  • Default: Groovy Documentation

<groovyDocJavaSources>

Whether to include Java sources in GroovyDoc generation.
  • Type: boolean
  • Since: 1.0-beta-2
  • Required: No
  • Default: true

<groovyDocOutputDirectory>

The location for the generated API docs.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/gapidocs

<groovyDocToolClass>

Allows you to override the class that is normally org.codehaus.groovy.tools.groovydoc.GroovyDocTool, for use when creating custom GroovyDoc implementations.
  • Type: java.lang.String
  • Since: 1.10.1
  • Required: No

<header>

The page header.
  • Type: java.lang.String
  • Required: No
  • Default: Groovy Documentation

<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.
  • Type: org.codehaus.gmavenplus.model.IncludeClasspath
  • Since: 1.8.0
  • Required: No
  • Default: PROJECT_ONLY

<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.
  • Type: java.lang.String
  • Since: 1.10.1
  • Required: No

<links>

Links to include in the generated GroovyDoc (key is link href, value is comma-separated packages to use that link).
  • Type: java.util.List<org.codehaus.gmavenplus.model.Link>
  • Since: 1.0-beta-2
  • Required: No

<outputToolClass>

Allows you to override the class that is normally org.codehaus.groovy.tools.groovydoc.OutputTool, for use when creating custom GroovyDoc implementations.
  • Type: java.lang.String
  • Since: 1.10.1
  • Required: No

<overviewFile>

The HTML file to be used for overview documentation.
  • Type: java.io.File
  • Required: No

<resourceManagerClass>

Allows you to override the class that is normally org.codehaus.groovy.tools.groovydoc.ResourceManager, for use when creating custom GroovyDoc implementations.
  • Type: java.lang.String
  • Since: 1.10.1
  • Required: No

<scope>

The scope to generate GroovyDoc for. Should be one of:
  • "public"
  • "protected"
  • "package"
  • "private"
  • Type: java.lang.String
  • Required: No
  • Default: private

<skipGroovyDoc>

Flag to allow GroovyDoc generation to be skipped.
  • Type: boolean
  • Since: 1.6
  • Required: No
  • User Property: skipGroovydoc
  • Default: false

<sources>

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

<stylesheetEncoding>

The encoding of stylesheetFile.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.sourceEncoding}

<stylesheetFile>

The stylesheet file (absolute path) to copy to output directory (will overwrite default stylesheet.css).
  • Type: java.io.File
  • Required: No

<windowTitle>

The window title.
  • Type: java.lang.String
  • Required: No
  • Default: Groovy Documentation