Groovydoc

Groovydoc 中包含的最严格的访问级别。

例如，要包含具有包、受保护和公共访问的类和成员，请使用 GroovydocAccess.PACKAGE。

用于定位文档化源代码所引用类的类路径。

生成文档的目录。

包索引（第一）页的标题。如果没有文档标题，则设置为 null。

排除模式集。

每个页面的 HTML 页脚。如果没有页脚，则设置为 null。

包含要使用的 Groovy 库的类路径。

每个页面的 HTML 页眉。如果没有页眉，则设置为 null。

是否包含作者段落。

是否为脚本包含 main 方法。

包含模式集。

指向给定 URL 的 groovydoc/javadoc 输出的链接。

是否在生成的 HTML 的隐藏注释中包含时间戳（Groovy >= 2.4.6）。

是否在生成的 HTML 的隐藏注释中包含版本戳（Groovy >= 2.4.6）。

返回用于概述文档的 HTML 文本。如果没有概述文本，则设置为 null。

是否处理脚本。

应用包含和排除模式后，此任务的源。忽略不存在的源文件。

源代码的 PathSensitivity 配置为 PathSensitivity.ABSOLUTE。如果您的源代码限制较少，请通过在子类中重写此方法进行相应更改。

是否创建类和包使用页面。

文档的浏览器窗口标题。如果没有窗口标题，则设置为 null。

添加一个排除规范。此方法可以多次调用以附加新的规范。给定闭包的参数为 FileTreeElement。闭包应返回 true 或 false。示例

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

如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能进行处理。

添加 ANT 样式排除模式。此方法可以多次调用以附加新模式，并且可以在单个调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能进行处理。

添加 ANT 样式排除模式。此方法可以多次调用以附加新模式，并且可以在单个调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能进行处理。

添加排除规范。此方法可以多次调用以追加新的规范。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件必须不匹配任何排除模式才能进行处理。

添加一个包含规范。此方法可以多次调用以附加新的规范。给定闭包的参数为 FileTreeElement。如果未提供包含项，则此容器中的所有文件都将包含在内。如果提供了包含项，则文件必须匹配至少一个包含模式或规范才能包含在内。

添加 ANT 样式包含模式。此方法可以多次调用以附加新模式，并且可以在单个调用中指定多个模式。如果未提供包含项，则此容器中的所有文件都将包含在内。如果提供了包含项，则文件必须匹配至少一个包含模式才能进行处理。

添加 ANT 样式包含模式。此方法可以多次调用以附加新模式，并且可以在单个调用中指定多个模式。如果未提供包含项，则此容器中的所有文件都将包含在内。如果提供了包含项，则文件必须匹配至少一个包含模式才能进行处理。

添加一个包含规范。此方法可以多次调用以附加新的规范。如果未提供包含项，则此容器中的所有文件都将包含在内。如果提供了包含项，则文件必须匹配至少一个包含模式或规范才能包含在内。

在给定 URL 处添加指向 groovydoc/javadoc 输出的链接。

向此任务添加一些源。给定源对象将按照 Project.files(java.lang.Object[]) 进行评估。