Java文档

特性
方法
脚本块
物业详情
方法详情

API文档：	`Javadoc`

为 Java 类生成 HTML API 文档。

如果您创建自己的 Javadoc 任务，请记住指定“source”属性！如果没有源，Javadoc 任务将不会创建任何文档。例子：

plugins {
    id 'java'
}

task myJavadocs(type: Javadoc) {
  source = sourceSets.main.allJava
}

如何创建运行自定义 doclet 实现的任务的示例：

plugins {
    id 'java'
}

configurations {
  jaxDoclet
}

dependencies {
  //jaxDoclet "some.interesting:Dependency:1.0"
}

task generateRestApiDocs(type: Javadoc) {
  source = sourceSets.main.allJava
  destinationDir = reporting.file("rest-api-docs")
  options.docletpath = configurations.jaxDoclet.files.asType(List)
  options.doclet = "com.lunatech.doclets.jax.jaxrs.JAXRSDoclet"
  options.addStringOption("jaxrscontext", "http://localhost:8080/myapp")
}

特性

财产	描述
`classpath`	用于解析源代码中的类型引用的类路径。
`destinationDir`	生成文档的目录。
`excludes`	排除模式集。
`executable`	用于生成 Javadoc 的 Javadoc 可执行文件。当时`null`，使用当前 JVM 的 Javadoc 可执行文件或来自工具链（如果已配置）。
`failOnError`	指定当 Javadoc 生成期间遇到错误时此任务是否应失败。当时`true`，此任务将因 Javadoc 错误而失败。当时`false`，此任务将忽略 Javadoc 错误。
`includes`	包含模式集。
`javadocTool`	配置用于生成 javadoc 文档的 javadoc 可执行文件。
`maxMemory`	分配给该任务的内存量。
`modularity`	此 javadoc 任务的模块路径处理。
`options`	Javadoc 生成选项。
`source`	应用包含和排除模式后此任务的源。忽略不存在的源文件。
`title`	生成的文档的标题。

方法

方法	描述
`exclude(excludeSpec)`	添加排除规范。可以多次调用此方法来附加新规范。给定的闭包将 `FileTreeElement`作为其参数传递。闭包应该返回 true 或 false。例子：
`exclude(excludes)`	添加 ANT 样式排除模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件不得与要处理的任何排除模式匹配。
`exclude(excludes)`	添加 ANT 样式排除模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件不得与要处理的任何排除模式匹配。
`exclude(excludeSpec)`	添加排除规范。可以多次调用此方法来附加新规范。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件不得与要处理的任何排除模式匹配。
`include(includeSpec)`	添加包含规范。可以多次调用此方法来附加新规范。给定的闭包将 a`FileTreeElement`作为其参数传递。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要包含的包含模式或规范之一。
`include(includes)`	添加 ANT 样式包含模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要处理的包含模式之一。
`include(includes)`	添加 ANT 样式包含模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要处理的包含模式之一。
`include(includeSpec)`	添加包含规范。可以多次调用此方法来附加新规范。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要包含的包含模式或规范之一。
`source(sources)`	向此任务添加一些源。给定的源对象将根据进行评估`Project.files(java.lang.Object[])`。

脚本块

无脚本块

物业详情

`FileCollection` `classpath`

用于解析源代码中的类型引用的类路径。

默认使用java插件：: project.sourceSets.main.compileClasspath

`File` `destinationDir`

生成文档的目录。

默认使用java插件：: ${project.docsDir}/javadoc

`Set<String>` `excludes`

排除模式集。

`String` `executable`

用于生成 Javadoc 的 Javadoc 可执行文件。当时null，使用当前 JVM 的 Javadoc 可执行文件或来自工具链（如果已配置）。

默认使用java插件：: null

`boolean` `failOnError`

指定当 Javadoc 生成期间遇到错误时此任务是否应失败。当时true，此任务将因 Javadoc 错误而失败。当时false，此任务将忽略 Javadoc 错误。

默认使用java插件：: true

`Set<String>` `includes`

包含模式集。

`Property<JavadocTool>` `javadocTool`

配置用于生成 javadoc 文档的 javadoc 可执行文件。

默认使用java插件：: java.toolchain

`String` `maxMemory`

分配给该任务的内存量。

默认使用java插件：: null

`ModularitySpec` `modularity`（只读）

此 javadoc 任务的模块路径处理。

`MinimalJavadocOptions` `options`（只读）

Javadoc 生成选项。

`FileTree` `source`（只读）

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

源的PathSensitivity被配置为PathSensitivity.ABSOLUTE。如果您的来源不太严格，请通过在您的子类中重写此方法来相应地更改它。

默认使用java插件：: project.sourceSets.main.allJava

`String` `title`

生成的文档的标题。

默认使用java插件：: 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...`不包括）

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

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

`SourceTask` `include`（`Closure`包括规格）

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

`SourceTask` `include`（包括）`Iterable<String>`

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

`SourceTask` `include`（`String...`包括）

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

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

`SourceTask` `source`（`Object...`来源）

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

Java文档

特性

方法

脚本块

物业详情

FileCollection classpath

File destinationDir

Set<String> excludes

String executable

boolean failOnError

Set<String> includes

Property<JavadocTool> javadocTool

String maxMemory

ModularitySpec modularity（只读）

MinimalJavadocOptions options（只读）

FileTree source（只读）

String title