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 可执行文件。当为 |
failOnError | 指定在此任务生成 Javadoc 期间遇到错误时是否应失败。当为 |
includes | 包含模式集合。 |
javadocTool | 配置用于生成 javadoc 文档的 javadoc 可执行文件。 |
maxMemory | 为此任务分配的内存量。 |
modularity | 此 javadoc 任务的模块路径处理方式。 |
options | Javadoc 生成选项。 |
source | 应用包含和排除模式后,此任务的源。忽略不存在的源文件。 |
title | 生成文档的标题。 |
方法 | 描述 |
exclude(excludeSpec) | 添加一个排除规范。此方法可以多次调用以追加新的规范。给定的闭包将 |
exclude(excludes) | 添加一个 ANT 风格的排除模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。 |
exclude(excludes) | 添加一个 ANT 风格的排除模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。 |
exclude(excludeSpec) | 添加一个排除规范。此方法可以多次调用以追加新的规范。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。 |
include(includeSpec) | 添加一个包含规范。此方法可以多次调用以追加新的规范。给定的闭包将 |
include(includes) | 添加一个 ANT 风格的包含模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供包含项,则将包含此容器中的所有文件。如果提供了包含项,则文件必须至少匹配一个包含模式才能被处理。 |
include(includes) | 添加一个 ANT 风格的包含模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供包含项,则将包含此容器中的所有文件。如果提供了包含项,则文件必须至少匹配一个包含模式才能被处理。 |
include(includeSpec) | 添加一个包含规范。此方法可以多次调用以追加新的规范。如果未提供包含项,则将包含此容器中的所有文件。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能被包含。 |
source(sources) | 为此任务添加一些源。给定的源对象将按照 |
String
executable
用于生成 Javadoc 的 Javadoc 可执行文件。当为 null
时,使用当前 JVM 的 Javadoc 可执行文件,或者如果配置了工具链,则使用工具链中的可执行文件。
- 使用
java
插件时的默认值 null
指定在此任务生成 Javadoc 期间遇到错误时是否应失败。当为 true
时,此任务将在 Javadoc 错误时失败。当为 false
时,此任务将忽略 Javadoc 错误。
- 使用
java
插件时的默认值 true
ModularitySpec
modularity
(只读)
此 javadoc 任务的模块路径处理方式。
MinimalJavadocOptions
options
(只读)
Javadoc 生成选项。
FileTree
source
(只读)
应用包含和排除模式后,此任务的源。忽略不存在的源文件。
源的 PathSensitivity
配置为 PathSensitivity.ABSOLUTE
。如果您的源不太严格,请在子类中覆盖此方法进行相应更改。
- 使用
java
插件时的默认值 project.sourceSets.main.allJava
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)
Iterable
<String
>添加一个 ANT 风格的排除模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。
SourceTask
exclude
(String
...
excludes)
String
...添加一个 ANT 风格的排除模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。
SourceTask
exclude
(Spec
<FileTreeElement
>
excludeSpec)
Spec
<FileTreeElement
>添加一个排除规范。此方法可以多次调用以追加新的规范。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。
添加一个排除规范。此方法可以多次调用以追加新的规范。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。
添加一个包含规范。此方法可以多次调用以追加新的规范。给定的闭包将 FileTreeElement
作为其参数。如果未提供包含项,则将包含此容器中的所有文件。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能被包含。
SourceTask
include
(Closure
includeSpec)
添加一个 ANT 风格的包含模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供包含项,则将包含此容器中的所有文件。如果提供了包含项,则文件必须至少匹配一个包含模式才能被处理。
添加一个包含规范。此方法可以多次调用以追加新的规范。给定的闭包将 FileTreeElement
作为其参数。如果未提供包含项,则将包含此容器中的所有文件。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能被包含。
添加一个 ANT 风格的包含模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供包含项,则将包含此容器中的所有文件。如果提供了包含项,则文件必须至少匹配一个包含模式才能被处理。
SourceTask
include
(Iterable
<String
>
includes)
Iterable
<String
>添加一个包含规范。此方法可以多次调用以追加新的规范。如果未提供包含项,则将包含此容器中的所有文件。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能被包含。
添加一个 ANT 风格的包含模式。此方法可以多次调用以追加新的模式,也可以在一次调用中指定多个模式。如果未提供包含项,则将包含此容器中的所有文件。如果提供了包含项,则文件必须至少匹配一个包含模式才能被处理。
为此任务添加一些源。给定的源对象将按照 Project.files(java.lang.Object[])
进行评估。