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)

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

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不包括规格）

添加排除规范。可以多次调用此方法来附加新规范。给定的闭包将 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>

添加 ANT 样式排除模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件不得与要处理的任何排除模式匹配。

SourceTask exclude（String...不包括）

添加 ANT 样式排除模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件不得与要处理的任何排除模式匹配。

SourceTask exclude（不包括规格）Spec<FileTreeElement>

添加排除规范。可以多次调用此方法来附加新规范。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件不得与要处理的任何排除模式匹配。

SourceTask include（Closure包括规格）

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

SourceTask include（包括）Iterable<String>

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

SourceTask include（String...包括）

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

SourceTask include（包括规格）Spec<FileTreeElement>

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

void link（String网址、String...包）

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

SourceTask source（Object...来源）

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