| API 文件 | ScalaDoc |
|---|
為 Scala 原始碼檔案產生 HTML API 文件。
| 屬性 | 說明 |
classpath | 用於尋找文件中參考類別的路徑。 |
compilationOutputs | 產生 Scala 文件之來源產生的編譯輸出。 |
destinationDir | 產生 API 文件的目錄。 |
excludes | 排除模式的集合。 |
includes | 包含模式的集合。 |
javaLauncher | 用於執行 ScalaDoc 工具的 JavaLauncher。 |
maxMemory | 分配給此任務的記憶體量。範例：512m、1G |
scalaClasspath | 用於載入 ScalaDoc 工具的路徑。 |
scalaDocOptions | ScalaDoc 產生選項。 |
source | 套用包含和排除模式後，此任務的來源。忽略不存在的原始碼檔案。 |
title | 文件標題。 |
| 方法 | 說明 |
exclude(excludeSpec) | 新增排除規格。此方法可多次呼叫以附加新規格。給定的閉包會傳遞 |
exclude(excludes) | 新增 ANT 樣式的排除模式。此方法可多次呼叫以附加新模式，且可在單次呼叫中指定多個模式。若未提供排除模式，則不會排除任何檔案。若提供排除模式，則檔案不得符合任何排除模式才能進行處理。 |
exclude(excludes) | 新增 ANT 樣式的排除模式。此方法可多次呼叫以附加新模式，且可在單次呼叫中指定多個模式。若未提供排除模式，則不會排除任何檔案。若提供排除模式，則檔案不得符合任何排除模式才能進行處理。 |
exclude(excludeSpec) | 新增排除規格。此方法可多次呼叫以附加新規格。若未提供排除模式，則不會排除任何檔案。若提供排除模式，則檔案不得符合任何排除模式才能進行處理。 |
include(includeSpec) | 新增包含規格。此方法可多次呼叫以附加新規格。給定的閉包會傳遞 |
include(includes) | 新增 ANT 樣式的包含模式。此方法可多次呼叫以附加新模式，且可在單次呼叫中指定多個模式。若未提供包含模式，則會包含此容器中的所有檔案。若提供包含模式，則檔案必須符合至少一個包含模式才能進行處理。 |
include(includes) | 新增 ANT 樣式的包含模式。此方法可多次呼叫以附加新模式，且可在單次呼叫中指定多個模式。若未提供包含模式，則會包含此容器中的所有檔案。若提供包含模式，則檔案必須符合至少一個包含模式才能進行處理。 |
include(includeSpec) | 新增包含規格。此方法可多次呼叫以附加新規格。若未提供包含模式，則會包含此容器中的所有檔案。若提供包含模式，則檔案必須符合至少一個包含模式或規格才能包含在內。 |
source(sources) | 為此任務新增一些來源。給定的來源物件將根據 |
FileCollection classpath
用於尋找文件中參考類別的路徑。
- 預設搭配
scala外掛程式 project.sourceSets.main.output + project.sourceSets.main.compileClasspath
ConfigurableFileCollection compilationOutputs (唯讀)
產生 Scala 文件之來源產生的編譯輸出。
- 預設搭配
scala外掛程式 project.sourceSets.main.output
FileCollection scalaClasspath
用於載入 ScalaDoc 工具的路徑。
- 預設搭配
scala外掛程式 scala-compiler相依性，與在classpath上找到的scala-library版本相符
ScalaDocOptions scalaDocOptions
ScalaDoc 產生選項。
FileTree source (唯讀)
套用包含和排除模式後，此任務的來源。忽略不存在的原始碼檔案。
來源的 PathSensitivity 設定為 PathSensitivity.RELATIVE。
- 預設搭配
scala外掛程式 project.sourceSets.main.scala
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>
Iterable<String>新增 ANT 樣式的排除模式。此方法可多次呼叫以附加新模式，且可在單次呼叫中指定多個模式。若未提供排除模式，則不會排除任何檔案。若提供排除模式，則檔案不得符合任何排除模式才能進行處理。
SourceTask exclude(String...
String...新增 ANT 樣式的排除模式。此方法可多次呼叫以附加新模式，且可在單次呼叫中指定多個模式。若未提供排除模式，則不會排除任何檔案。若提供排除模式，則檔案不得符合任何排除模式才能進行處理。
SourceTask exclude(Spec<FileTreeElement>
Spec<FileTreeElement>新增排除規格。此方法可多次呼叫以附加新規格。若未提供排除模式，則不會排除任何檔案。若提供排除模式，則檔案不得符合任何排除模式才能進行處理。
SourceTask include(Closure includeSpec)
新增包含規格。此方法可多次呼叫以附加新規格。給定的閉包會傳遞 FileTreeElement 作為其參數。若未提供包含模式，則會包含此容器中的所有檔案。若提供包含模式，則檔案必須符合至少一個包含模式或規格才能包含在內。
SourceTask include(Iterable<String>
Iterable<String>新增 ANT 樣式的包含模式。此方法可多次呼叫以附加新模式，且可在單次呼叫中指定多個模式。若未提供包含模式，則會包含此容器中的所有檔案。若提供包含模式，則檔案必須符合至少一個包含模式才能進行處理。
SourceTask include(String...
String...新增 ANT 樣式的包含模式。此方法可多次呼叫以附加新模式，且可在單次呼叫中指定多個模式。若未提供包含模式，則會包含此容器中的所有檔案。若提供包含模式，則檔案必須符合至少一個包含模式才能進行處理。
SourceTask include(Spec<FileTreeElement>
Spec<FileTreeElement>新增包含規格。此方法可多次呼叫以附加新規格。若未提供包含模式，則會包含此容器中的所有檔案。若提供包含模式，則檔案必須符合至少一個包含模式或規格才能包含在內。
SourceTask source(Object...
Object...為此任務新增一些來源。給定的來源物件將根據 Project.files(java.lang.Object[]) 進行評估。