Javadoc

目录

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

为 Java 类生成 HTML API 文档。

如果您创建自己的 Javadoc 任务，请记得指定“source”属性！如果没有 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", "https://:8080/myapp")
}

属性

属性描述
类路径

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

destinationDir

生成文档的目标目录。

excludes

排除模式集。

可执行文件

用于生成 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 风格的排除模式。此方法可以多次调用以附加新的模式，并且可以在一次调用中指定多个模式。如果未提供 excludes，则不会排除任何文件。如果提供了 excludes，则文件必须不匹配任何排除模式才能进行处理。

exclude(excludes)

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

exclude(excludeSpec)

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

include(includeSpec)

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

include(includes)

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

include(includes)

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

include(includeSpec)

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

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 (只读)

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

sources 的 PathSensitivity 配置为 PathSensitivity.ABSOLUTE。如果您的 sources 限制较少，请在您的子类中覆盖此方法以相应地更改它。

默认与java插件一起使用
project.sourceSets.main.allJava

String title

生成文档的标题。

默认与java插件一起使用
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 风格的排除模式。此方法可以多次调用以附加新的模式，并且可以在一次调用中指定多个模式。如果未提供 excludes，则不会排除任何文件。如果提供了 excludes，则文件必须不匹配任何排除模式才能进行处理。

SourceTask exclude(String... excludes)

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

SourceTask exclude(Spec<FileTreeElement> excludeSpec)

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

SourceTask include(Closure includeSpec)

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

SourceTask include(Iterable<String> includes)

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

SourceTask include(String... includes)

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

SourceTask include(Spec<FileTreeElement> includeSpec)

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

SourceTask source(Object... sources)

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