@groovy.transform.CompileStatic class GroovydocEnhancerExtension extends java.lang.Object
Extension for configuring the Groovydoc Enhancer convention plugin.
This plugin replaces Gradle's built-in Groovydoc task execution with
a direct AntBuilder invocation of the Groovy org.codehaus.groovy.ant.Groovydoc
Ant task. This enables the javaVersion parameter (added in Groovy 4.0.27,
GROOVY-11668) which controls the JavaParser language level used when parsing
Java source files.
When Gradle natively supports the javaVersion property
(see gradle#33659),
set useAntBuilder to false to revert to Gradle's built-in
Groovydoc task execution while retaining all other configuration (footer,
defaults, etc.).
| Type | Name and description |
|---|---|
Property<java.lang.String> |
footerHTML footer appended to every generated groovydoc page. |
Property<java.lang.String> |
javaVersionThe Java language level string passed to the groovydoc Ant task's javaVersion parameter (e.g. |
Property<java.lang.Boolean> |
javaVersionEnabledWhether to pass the javaVersion parameter to the groovydoc
Ant task. |
Property<java.lang.Boolean> |
useAntBuilderWhether to replace Gradle's built-in Groovydoc task execution with AntBuilder invocation. |
| Constructor and description |
|---|
GroovydocEnhancerExtension(ObjectFactory objects, org.apache.tools.ant.Project project) |
| Methods inherited from class | Name |
|---|---|
class java.lang.Object |
java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int) |
HTML footer appended to every generated groovydoc page. Useful for analytics scripts, copyright notices, or custom branding.
Defaults to an empty string (no footer).
The Java language level string passed to the groovydoc Ant task's
javaVersion parameter (e.g. "JAVA_17", "JAVA_21").
Derived from the project's javaVersion property
(e.g. "JAVA_17"). The property must be defined in
gradle.properties; a missing value will cause a build failure.
Whether to pass the javaVersion parameter to the groovydoc
Ant task. Set to false for projects using Groovy versions
older than 4.0.27 (which do not support the parameter).
Defaults to true.
Whether to replace Gradle's built-in Groovydoc task execution with
AntBuilder invocation. When true (default), the plugin clears
the task's actions and replaces them with a doLast that uses
AntBuilder. When false, the plugin only applies property
defaults (footer, etc.) and lets Gradle's built-in task run normally.
Set to false when Gradle adds native javaVersion
support (gradle/gradle#33659).
Defaults to true.