ScalaDoc

目录

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

为 Scala 源文件生成 HTML API 文档。

属性

属性描述
类路径

用于定位文档源引用的类的类路径。

compilationOutputs

由生成 ScalaDoc 的源文件产生的编译输出。

destinationDir

生成 API 文档的目录。

excludes

排除模式集。

includes

包含模式集。

javaLauncher

用于运行 Scaladoc 工具的 JavaLauncher。

maxMemory

分配给此任务的内存量。例如 512m, 1G

scalaClasspath

用于加载 ScalaDoc 工具的类路径。

scalaDocOptions

ScalaDoc 生成选项。

source

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

title

文档标题。

方法

方法描述
exclude(excludeSpec)

添加一个排除规范。此方法可以多次调用以追加新的规范。给定的闭包将其参数作为 FileTreeElement 传递。闭包应返回 true 或 false。示例

exclude(excludes)

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

exclude(excludes)

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

exclude(excludeSpec)

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

include(includeSpec)

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

include(includes)

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

include(includes)

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

include(includeSpec)

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

source(sources)

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

脚本块

无脚本块

属性详情

FileCollection classpath

用于定位文档源引用的类的类路径。

使用 scala 插件的默认值
project.sourceSets.main.output + project.sourceSets.main.compileClasspath

ConfigurableFileCollection compilationOutputs (只读)

由生成 ScalaDoc 的源文件产生的编译输出。

使用 scala 插件的默认值
project.sourceSets.main.output

File destinationDir

生成 API 文档的目录。

使用 scala 插件的默认值
${project.docsDir}/scaladoc

Set<String> excludes

排除模式集。

Set<String> includes

包含模式集。

Property<JavaLauncher> javaLauncher

用于运行 Scaladoc 工具的 JavaLauncher。

使用 scala 插件的默认值
java.toolchain

Property<String> maxMemory

分配给此任务的内存量。例如 512m, 1G

使用 scala 插件的默认值
null

FileCollection scalaClasspath

用于加载 ScalaDoc 工具的类路径。

使用 scala 插件的默认值
与 classpath 上找到的 scala-library 版本匹配的 scala-compiler 依赖项

ScalaDocOptions scalaDocOptions (只读)

ScalaDoc 生成选项。

FileTree source (只读)

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

源的 PathSensitivity 配置为 PathSensitivity.RELATIVE。

使用 scala 插件的默认值
project.sourceSets.main.scala

String title

文档标题。

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

SourceTask exclude(String... excludes)

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

SourceTask exclude(Spec<FileTreeElement> excludeSpec)

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

SourceTask include(Closure includeSpec)

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

SourceTask include(Iterable<String> includes)

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

SourceTask include(String... includes)

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

SourceTask include(Spec<FileTreeElement> includeSpec)

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

SourceTask source(Object... sources)

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