Groovydoc

The most restrictive access level to include in the Groovydoc.

For example, to include classes and members with package, protected, and public access, use GroovydocAccess.PACKAGE.

Additional stylesheets to copy into the generated documentation alongside the default stylesheet, preserving each file's name.

Only has an effect with Groovy 6.0.0 or later; the stylesheets are silently ignored with earlier Groovy versions.

The classpath used to locate classes referenced by the documented sources.

The directory to generate the documentation into.

The directory to generate the documentation into.

The title for the package index(first) page. Set to null when there is no document title.

The set of exclude patterns.

The HTML footer for each page. Set to null when there is no footer.

The classpath containing the Groovy library to be used.

The HTML header for each page. Set to null when there is no header.

Whether to include author paragraphs.

Whether to include main method for scripts.

The set of include patterns.

The Java launcher used to start the worker process for generating Groovydoc.

The Java language version used when parsing Java source files, e.g. <UNHANDLED-LINK>JavaLanguageVersion#of(int) JavaLanguageVersion.of(17)</UNHANDLED-LINK>.

Groovydoc uses the JavaParser library to read Java sources; this controls the source level it assumes, which is needed for parsing newer Java language constructs (for example, sealed classes require Java 17). When unset, Groovydoc uses the JavaParser library's own default.

Only has an effect with Groovy 4.0.27 or later; the option is silently ignored with earlier Groovy versions.

The links to groovydoc/javadoc output at the given URL.

The amount of memory allocated to this task. Ex. 512m, 1G

Whether to suppress generation of the deprecated-list page (deprecated-list.html) and its nav-bar link.

Defaults to false. Only has an effect with Groovy 6.0.0 or later; the option is silently ignored with earlier Groovy versions.

Whether to suppress generation of the help page (help-doc.html) and its nav-bar link.

Defaults to false. Only has an effect with Groovy 6.0.0 or later; the option is silently ignored with earlier Groovy versions.

Whether to suppress generation of the alphabetical index page (index-all.html) and its nav-bar link.

Defaults to false. Only has an effect with Groovy 6.0.0 or later; the option is silently ignored with earlier Groovy versions.

Whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).

Whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).

Returns a HTML text to be used for overview documentation. Set to null when there is no overview text.

The default language id applied to preformatted code blocks in rendered doc comments that carry no class attribute.

When set (for example, "groovy"), a post-pass adds class="language-xxx" to the opening tag of such blocks, enabling syntax highlighting for legacy doc-comment code blocks without touching source files. Blocks that already carry any class attribute are left alone.

Only has an effect with Groovy 6.0.0 or later; the option is silently ignored with earlier Groovy versions.

Whether to process scripts.

Whether to include members annotated with groovy.transform.Internal (per GEP-17) in the generated documentation.

Defaults to false, so internal members are hidden. Only has an effect with Groovy 6.0.0 or later; the option is silently ignored with earlier Groovy versions.

The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.

The PathSensitivity for the sources is configured to be PathSensitivity.ABSOLUTE. If your sources are less strict, please change it accordingly by overriding this method in your subclass.

The client-side syntax highlighter for {@snippet} and fenced Markdown code blocks.

Valid values are "prism" (bundled) or "none" (default); any other value is treated as "none". Only has an effect with Groovy 6.0.0 or later; the option is silently ignored with earlier Groovy versions.

The theme lock mode for the generated documentation.

Any other value is treated as "auto". Only has an effect with Groovy 6.0.0 or later; the option is silently ignored with earlier Groovy versions.

Whether to create class and package usage pages.

The browser window title for the documentation. Set to null when there is no window title.

Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a FileTreeElement as its parameter. The closure should return true or false. Example:

copySpec {
  from 'source'
  into 'destination'
  //an example of excluding files from certain configuration:
  exclude { it.file in configurations.someConf.files }
}

If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.

Adds an Ant style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.

Adds an Ant style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.

Adds an exclude spec. This method may be called multiple times to append new specs. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.

Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a FileTreeElement as its parameter. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.

Adds an Ant style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.

Adds an Ant style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.

Adds an include spec. This method may be called multiple times to append new specs. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.

Add links to groovydoc/javadoc output at the given URL.

Adds some source to this task. The given source objects will be evaluated as per Project.files(java.lang.Object[]).