Full name:
org.codehaus.gmavenplus:gmavenplus-plugin:3.0.2:groovydocTests
Description:
Generates GroovyDoc for the test sources.
Attributes:
test
.1.0-beta-1
.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 |
<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
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:
Default: private |
<skipGroovyDoc> |
boolean |
1.6 |
Flag to allow GroovyDoc generation to be skipped. Default: false User Property: skipGroovydoc |
<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). |
<testGroovyDocJavaSources> |
boolean |
1.7 |
Whether to include test Java sources in GroovyDoc generation. Default: true |
<testGroovyDocOutputDirectory> |
File |
- |
The location for the generated test API docs. Default: ${project.build.directory}/testgapidocs |
<testSources> |
FileSet[] |
- |
The Groovy test source files (relative paths). Default: "${project.basedir}/src/test/groovy/**/*.groovy" |
<windowTitle> |
String |
- |
The window title. Default: Groovy Documentation |
boolean
1.11.0
report.plugin.goal.no
false
java.lang.String
1.10.1
report.plugin.goal.no
java.lang.String[]
1.10.1
report.plugin.goal.no
java.lang.String[]
1.10.1
report.plugin.goal.no
java.lang.String[]
1.10.1
report.plugin.goal.no
boolean
report.plugin.goal.no
true
java.lang.String
report.plugin.goal.no
Groovy Documentation
java.lang.String
1.10.1
report.plugin.goal.no
java.lang.String
report.plugin.goal.no
Groovy Documentation
java.lang.String
1.10.1
report.plugin.goal.no
java.lang.String
report.plugin.goal.no
Groovy Documentation
org.codehaus.gmavenplus.model.IncludeClasspath
1.8.0
report.plugin.goal.no
PROJECT_ONLY
java.lang.String
1.10.1
report.plugin.goal.no
java.util.List<org.codehaus.gmavenplus.model.Link>
1.0-beta-2
report.plugin.goal.no
java.lang.String
1.10.1
report.plugin.goal.no
java.io.File
report.plugin.goal.no
java.lang.String
1.10.1
report.plugin.goal.no
java.lang.String
report.plugin.goal.no
private
boolean
1.6
report.plugin.goal.no
skipGroovydoc
false
java.lang.String
report.plugin.goal.no
${project.build.sourceEncoding}
java.io.File
report.plugin.goal.no
boolean
1.7
report.plugin.goal.no
true
java.io.File
report.plugin.goal.no
${project.build.directory}/testgapidocs
org.apache.maven.shared.model.fileset.FileSet[]
report.plugin.goal.no
java.lang.String
report.plugin.goal.no
Groovy Documentation