ScalaDoc

目录

属性
方法
脚本块
属性详情
方法详情
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)

添加包含规范。可以多次调用此方法以追加新规范。给定的闭包会传递一个 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[]) 进行评估。