Scala文档

目录

特性
方法
脚本块
物业详情
方法详情
API文档：ScalaDoc

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

特性

财产描述
classpath

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

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)

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

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插件：
scala-compilerscala-library与找到的版本相匹配的依赖项classpath

ScalaDocOptions scalaDocOptions

ScalaDoc 生成选项。

FileTree source（只读）

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

源的PathSensitivity被配置为PathSensitivity.RELATIVE。

默认使用scala插件：
project.sourceSets.main.scala

String title

文档标题。

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

添加 ANT 样式排除模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件不得与要处理的任何排除模式匹配。

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

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

SourceTask include（Closure包括规格）

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

SourceTask include（包括）Iterable<String>

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

SourceTask include（String...包括）

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

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

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

SourceTask source（Object...来源）

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