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://127.0.0.1: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 风格的排除模式。 可以多次调用此方法以追加新的模式,并且可以在单个调用中指定多个模式。 如果未提供 excludes,则不会排除任何文件。 如果提供了 excludes,则文件必须不匹配任何排除模式才能被处理。

exclude(excludes)

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

exclude(excludeSpec)

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

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

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

源的 PathSensitivity 被配置为 PathSensitivity.ABSOLUTE。 如果您的源要求不那么严格,请在您的子类中重写此方法以相应地更改它。

默认值,使用 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 }
}

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

SourceTask exclude(Iterable<String> excludes)

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

SourceTask exclude(String... excludes)

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

SourceTask exclude(Spec<FileTreeElement> excludeSpec)

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

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[]) 进行评估。