| API 文档 | ScalaDoc |
|---|
为 Scala 源文件生成 HTML API 文档。
| 属性 | 描述 |
classpath | 用于查找被文档化源代码所引用类的 classpath。 |
compilationOutputs | 生成 Scaladoc 的源代码产生的编译输出。 |
destinationDir | 生成 API 文档的目标目录。 |
excludes | 排除模式集。 |
includes | 包含模式集。 |
javaLauncher | 用于运行 Scaladoc 工具的 JavaLauncher。 |
maxMemory | 分配给此任务的内存量。例如 512m, 1G |
scalaClasspath | 用于加载 ScalaDoc 工具的 classpath。 |
scalaDocOptions | ScalaDoc 生成选项。 |
source | 应用包含和排除模式后的此任务源。忽略不存在的源文件。 |
title | 文档标题。 |
| 方法 | 描述 |
exclude(excludeSpec) | 添加一个排除规范 (exclude spec)。此方法可以多次调用以追加新的规范。给定的闭包 (closure) 将 |
exclude(excludes) | 添加 ANT 风格的排除模式。此方法可以多次调用以追加新的模式，也可在单次调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。 |
exclude(excludes) | 添加 ANT 风格的排除模式。此方法可以多次调用以追加新的模式，也可在单次调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。 |
exclude(excludeSpec) | 添加一个排除规范 (exclude spec)。此方法可以多次调用以追加新的规范。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。 |
include(includeSpec) | 添加一个包含规范 (include spec)。此方法可以多次调用以追加新的规范。给定的闭包 (closure) 将 |
include(includes) | 添加 ANT 风格的包含模式。此方法可以多次调用以追加新的模式，也可在单次调用中指定多个模式。如果未提供包含项，则此容器中的所有文件都将被包含。如果提供了包含项，则文件必须匹配至少一个包含模式才能被处理。 |
include(includes) | 添加 ANT 风格的包含模式。此方法可以多次调用以追加新的模式，也可在单次调用中指定多个模式。如果未提供包含项，则此容器中的所有文件都将被包含。如果提供了包含项，则文件必须匹配至少一个包含模式才能被处理。 |
include(includeSpec) | 添加一个包含规范 (include spec)。此方法可以多次调用以追加新的规范。如果未提供包含项，则此容器中的所有文件都将被包含。如果提供了包含项，则文件必须匹配至少一个包含模式或规范才能被包含。 |
source(sources) | 向此任务添加一些源。给定源对象将按照 |
FileCollection classpath
用于查找被文档化源代码所引用类的 classpath。
- 使用
scala插件时的默认值 project.sourceSets.main.output + project.sourceSets.main.compileClasspath
ConfigurableFileCollection compilationOutputs (只读)
生成 Scaladoc 的源代码产生的编译输出。
- 使用
scala插件时的默认值 project.sourceSets.main.output
FileCollection scalaClasspath
用于加载 ScalaDoc 工具的 classpath。
- 使用
scala插件时的默认值 - 与
classpath中找到的scala-library版本匹配的scala-compiler依赖
ScalaDocOptions scalaDocOptions
ScalaDoc 生成选项。
FileTree source (只读)
应用包含和排除模式后的此任务源。忽略不存在的源文件。
源代码的 PathSensitivity 配置为 PathSensitivity.RELATIVE。
- 使用
scala插件时的默认值 project.sourceSets.main.scala
SourceTask exclude(Closure excludeSpec)
添加一个排除规范 (exclude spec)。此方法可以多次调用以追加新的规范。给定的闭包 (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>
Iterable<String>添加 ANT 风格的排除模式。此方法可以多次调用以追加新的模式，也可在单次调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。
SourceTask exclude(String...
String...添加 ANT 风格的排除模式。此方法可以多次调用以追加新的模式，也可在单次调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。
SourceTask exclude(Spec<FileTreeElement>
Spec<FileTreeElement>添加一个排除规范 (exclude spec)。此方法可以多次调用以追加新的规范。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。
如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。
添加一个包含规范 (include spec)。此方法可以多次调用以追加新的规范。给定的闭包 (closure) 将 FileTreeElement 作为参数传入。如果未提供包含项，则此容器中的所有文件都将被包含。如果提供了包含项，则文件必须匹配至少一个包含模式或规范才能被包含。
SourceTask include(Closure includeSpec)
添加 ANT 风格的包含模式。此方法可以多次调用以追加新的模式，也可在单次调用中指定多个模式。如果未提供包含项，则此容器中的所有文件都将被包含。如果提供了包含项，则文件必须匹配至少一个包含模式才能被处理。
SourceTask include(Iterable<String>
Iterable<String>添加 ANT 风格的包含模式。此方法可以多次调用以追加新的模式，也可在单次调用中指定多个模式。如果未提供包含项，则此容器中的所有文件都将被包含。如果提供了包含项，则文件必须匹配至少一个包含模式才能被处理。
SourceTask include(String...
String...添加一个包含规范 (include spec)。此方法可以多次调用以追加新的规范。如果未提供包含项，则此容器中的所有文件都将被包含。如果提供了包含项，则文件必须匹配至少一个包含模式或规范才能被包含。
SourceTask include(Spec<FileTreeElement>
Spec<FileTreeElement>向此任务添加一些源。给定源对象将按照 Project.files(java.lang.Object[]) 进行评估。