Groovydoc

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

例如，要包含具有 package、protected 和 public 访问权限的类和成员，请使用 GroovydocAccess.PACKAGE。

用于查找文档化源码引用的类的 classpath。

生成文档的目标目录。

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

排除模式集。

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

包含要使用的 Groovy 库的 classpath。

每页的 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[]) 进行评估。