Groovydoc

目录

属性
方法
脚本块
属性详情
方法详情
API 文档Groovydoc

为 Groovy 源代码以及可选的 Java 源代码生成 HTML API 文档。

此任务使用 Groovy 的 Groovydoc 工具生成 API 文档。请注意，Groovydoc 工具目前有一些限制。使用的 Groovydoc 版本是构建脚本中定义的 Groovy 依赖项中的版本。

属性

属性描述
access

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

classpath

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

destinationDir

生成文档的目标目录。

docTitle

包索引（首页）页面的标题。当没有文档标题时，设置为 null。

excludes

排除模式的集合。

footer

每页的 HTML 页脚。当没有页脚时，设置为 null。

groovyClasspath

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

header

每页的 HTML 页眉。当没有页眉时，设置为 null。

includeAuthor

是否包含作者段落。

includeMainForScripts

是否为脚本包含 main 方法。

includes

包含模式的集合。

links

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

noTimestamp

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

noVersionStamp

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

overviewText

返回用于概览文档的 HTML 文本。当没有概览文本时，设置为 null。

processScripts

是否处理脚本。

source

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

use

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

windowTitle

文档的浏览器窗口标题。当没有窗口标题时，设置为 null。

方法

方法描述
exclude(excludeSpec)

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

exclude(excludes)

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

exclude(excludes)

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

exclude(excludeSpec)

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

include(includeSpec)

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

include(includes)

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

include(includes)

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

include(includeSpec)

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

link(url, packages)

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

source(sources)

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

脚本块

无脚本块

属性详情

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

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

使用 groovy 插件的默认值
GroovydocAccess.PROTECTED

FileCollection classpath

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

使用 groovy 插件的默认值
sourceSets.main.output + sourceSets.main.compileClasspath

File destinationDir

生成文档的目标目录。

使用 groovy 插件的默认值
${project.docsDir}/groovydoc

String docTitle

包索引（首页）页面的标题。当没有文档标题时，设置为 null。

使用 groovy 插件的默认值
project.reporting.apiDocTitle

Set<String> excludes

排除模式的集合。

String footer

每页的 HTML 页脚。当没有页脚时，设置为 null。

使用 groovy 插件的默认值
null

FileCollection groovyClasspath

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

使用 groovy 插件的默认值
project.configurations.groovy

String header

每页的 HTML 页眉。当没有页眉时，设置为 null。

使用 groovy 插件的默认值
null

Property<Boolean> includeAuthor

是否包含作者段落。

使用 groovy 插件的默认值
false

Property<Boolean> includeMainForScripts

是否为脚本包含 main 方法。

使用 groovy 插件的默认值
true

Set<String> includes

包含模式的集合。

Set<Link> links

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

使用 groovy 插件的默认值
[]

boolean noTimestamp

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

使用 groovy 插件的默认值
false

boolean noVersionStamp

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

使用 groovy 插件的默认值
false

TextResource overviewText

返回用于概览文档的 HTML 文本。当没有概览文本时，设置为 null。

使用 groovy 插件的默认值
null

Property<Boolean> processScripts

是否处理脚本。

使用 groovy 插件的默认值
true

FileTree source (只读)

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

源代码的 PathSensitivity 配置为 PathSensitivity.ABSOLUTE。如果您的源代码不那么严格，请在子类中覆盖此方法以相应地更改它。

使用 groovy 插件的默认值
sourceSets.main.groovy

boolean use

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

使用 groovy 插件的默认值
false

String windowTitle

文档的浏览器窗口标题。当没有窗口标题时，设置为 null。

使用 groovy 插件的默认值
project.reporting.apiDocTitle

方法详情

SourceTask exclude(Closure excludeSpec)

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

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

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

SourceTask exclude(Iterable<String> excludes)

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

SourceTask exclude(String... excludes)

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

SourceTask exclude(Spec<FileTreeElement> excludeSpec)

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

SourceTask include(Closure includeSpec)

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

SourceTask include(Iterable<String> includes)

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

SourceTask include(String... includes)

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

SourceTask include(Spec<FileTreeElement> includeSpec)

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

void link(String url, String... packages)

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

SourceTask source(Object... sources)

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