Groovydoc

目錄

屬性
方法
腳本區塊
屬性詳細資訊
方法詳細資訊
API 文件Groovydoc

為 Groovy 原始碼產生 HTML API 文件，並可選擇性地為 Java 原始碼產生文件。

此任務使用 Groovy 的 Groovydoc 工具來產生 API 文件。請注意，Groovydoc 工具目前有一些限制。使用的 Groovydoc 版本是從建置腳本中定義的 Groovy 依賴項而來。

屬性

屬性描述
存取權限

要包含在 Groovydoc 中的最嚴格存取層級。

類別路徑

用於定位文件來源所引用類別的類別路徑。

目標目錄

產生文件到其中的目錄。

文件標題

套件索引（首頁）頁面的標題。當沒有文件標題時，設定為 null。

排除

排除模式的集合。

頁尾

每個頁面的 HTML 頁尾。當沒有頁尾時，設定為 null。

Groovy 類別路徑

包含要使用的 Groovy 函式庫的類別路徑。

頁首

每個頁面的 HTML 頁首。當沒有頁首時，設定為 null。

包含作者

是否包含作者段落。

為腳本包含 main 方法

是否為腳本包含 main 方法。

包含

包含模式的集合。

連結

指向指定 URL 的 groovydoc/javadoc 輸出的連結。

無時間戳記

是否在產生的 HTML 的隱藏註解中包含時間戳記 (Groovy >= 2.4.6)。

無版本戳記

是否在產生的 HTML 的隱藏註解中包含版本戳記 (Groovy >= 2.4.6)。

概觀文字

傳回用於概觀文件的 HTML 文字。當沒有概觀文字時，設定為 null。

處理腳本

是否處理腳本。

來源

此任務的來源，在套用包含和排除模式之後。忽略不存在的來源檔案。

使用

是否建立類別和套件使用頁面。

視窗標題

文件的瀏覽器視窗標題。當沒有視窗標題時，設定為 null。

方法

方法描述
exclude(excludeSpec)

新增排除規範。此方法可以多次調用以附加新的規範。給定的閉包會傳遞一個 FileTreeElement 作為其參數。閉包應傳回 true 或 false。範例

exclude(excludes)

新增 ANT 樣式的排除模式。此方法可以多次調用以附加新的模式，並且可以在單次調用中指定多個模式。如果未提供排除模式，則不會排除任何檔案。如果提供了排除模式，則檔案不得符合任何排除模式才能進行處理。

exclude(excludes)

新增 ANT 樣式的排除模式。此方法可以多次調用以附加新的模式，並且可以在單次調用中指定多個模式。如果未提供排除模式，則不會排除任何檔案。如果提供了排除模式，則檔案不得符合任何排除模式才能進行處理。

exclude(excludeSpec)

新增排除規範。此方法可以多次調用以附加新的規範。如果未提供排除模式，則不會排除任何檔案。如果提供了排除模式，則檔案不得符合任何排除模式才能進行處理。

include(includeSpec)

新增包含規範。此方法可以多次調用以附加新的規範。給定的閉包會傳遞一個 FileTreeElement 作為其參數。如果未提供包含模式，則將包含此容器中的所有檔案。如果提供了包含模式，則檔案必須符合至少一個包含模式或規範才能被包含。

include(includes)

新增 ANT 樣式的包含模式。此方法可以多次調用以附加新的模式，並且可以在單次調用中指定多個模式。如果未提供包含模式，則將包含此容器中的所有檔案。如果提供了包含模式，則檔案必須符合至少一個包含模式才能進行處理。

include(includes)

新增 ANT 樣式的包含模式。此方法可以多次調用以附加新的模式，並且可以在單次調用中指定多個模式。如果未提供包含模式，則將包含此容器中的所有檔案。如果提供了包含模式，則檔案必須符合至少一個包含模式才能進行處理。

include(includeSpec)

新增包含規範。此方法可以多次調用以附加新的規範。如果未提供包含模式，則將包含此容器中的所有檔案。如果提供了包含模式，則檔案必須符合至少一個包含模式或規範才能被包含。

link(url, packages)

新增指向指定 URL 的 groovydoc/javadoc 輸出的連結。

source(sources)

為此任務新增一些來源。給定的來源物件將按照 Project.files(java.lang.Object[]) 進行評估。

腳本區塊

沒有腳本區塊

屬性詳細資訊

要包含在 Groovydoc 中的最嚴格存取層級。

例如，若要包含具有套件、受保護和公開存取權限的類別和成員，請使用 GroovydocAccess.PACKAGE。

使用 groovy 外掛的預設值
GroovydocAccess.PROTECTED

FileCollection 類別路徑

用於定位文件來源所引用類別的類別路徑。

使用 groovy 外掛的預設值
sourceSets.main.output + sourceSets.main.compileClasspath

File 目標目錄

產生文件到其中的目錄。

使用 groovy 外掛的預設值
${project.docsDir}/groovydoc

String 文件標題

套件索引（首頁）頁面的標題。當沒有文件標題時，設定為 null。

使用 groovy 外掛的預設值
project.reporting.apiDocTitle

Set<String> 排除

排除模式的集合。

String 頁尾

每個頁面的 HTML 頁尾。當沒有頁尾時，設定為 null。

使用 groovy 外掛的預設值
null

FileCollection Groovy 類別路徑

包含要使用的 Groovy 函式庫的類別路徑。

使用 groovy 外掛的預設值
project.configurations.groovy

String 頁首

每個頁面的 HTML 頁首。當沒有頁首時，設定為 null。

使用 groovy 外掛的預設值
null

Property<Boolean> 包含作者

是否包含作者段落。

使用 groovy 外掛的預設值
false

Property<Boolean> 為腳本包含 main 方法

是否為腳本包含 main 方法。

使用 groovy 外掛的預設值
true

Set<String> 包含

包含模式的集合。

Set<Link> 連結

指向指定 URL 的 groovydoc/javadoc 輸出的連結。

使用 groovy 外掛的預設值
[]

boolean 無時間戳記

是否在產生的 HTML 的隱藏註解中包含時間戳記 (Groovy >= 2.4.6)。

使用 groovy 外掛的預設值
false

boolean 無版本戳記

是否在產生的 HTML 的隱藏註解中包含版本戳記 (Groovy >= 2.4.6)。

使用 groovy 外掛的預設值
false

TextResource 概觀文字

傳回用於概觀文件的 HTML 文字。當沒有概觀文字時，設定為 null。

使用 groovy 外掛的預設值
null

Property<Boolean> 處理腳本

是否處理腳本。

使用 groovy 外掛的預設值
true

FileTree 來源 (唯讀)

此任務的來源，在套用包含和排除模式之後。忽略不存在的來源檔案。

來源的 PathSensitivity 配置為 PathSensitivity.ABSOLUTE。如果您的來源要求較不嚴格，請在您的子類別中覆寫此方法以相應地變更它。

使用 groovy 外掛的預設值
sourceSets.main.groovy

boolean 使用

是否建立類別和套件使用頁面。

使用 groovy 外掛的預設值
false

String 視窗標題

文件的瀏覽器視窗標題。當沒有視窗標題時，設定為 null。

使用 groovy 外掛的預設值
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)

新增包含規範。此方法可以多次調用以附加新的規範。如果未提供包含模式，則將包含此容器中的所有檔案。如果提供了包含模式，則檔案必須符合至少一個包含模式或規範才能被包含。

void link(String url, String... packages)

新增指向指定 URL 的 groovydoc/javadoc 輸出的連結。

SourceTask source(Object... sources)

為此任務新增一些來源。給定的來源物件將按照 Project.files(java.lang.Object[]) 進行評估。