Javadoc

目錄

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

為 Java 類別產生 HTML API 文件。

如果您建立自己的 Javadoc 任務，請記得指定 'source' 屬性！如果沒有來源，Javadoc 任務將不會建立任何文件。範例

plugins {
    id 'java'
}

task myJavadocs(type: Javadoc) {
  source = sourceSets.main.allJava
}

如何建立執行自訂 doclet 實作的任務範例

plugins {
    id 'java'
}

configurations {
  jaxDoclet
}

dependencies {
  //jaxDoclet "some.interesting:Dependency:1.0"
}

task generateRestApiDocs(type: Javadoc) {
  source = sourceSets.main.allJava
  destinationDir = reporting.file("rest-api-docs")
  options.docletpath = configurations.jaxDoclet.files.asType(List)
  options.doclet = "com.lunatech.doclets.jax.jaxrs.JAXRSDoclet"
  options.addStringOption("jaxrscontext", "https://127.0.0.1:8080/myapp")
}

屬性

屬性描述
classpath

用於解析原始碼中類型參考的類別路徑。

destinationDir

產生文件至其中的目錄。

excludes

排除模式的集合。

executable

用於產生 Javadoc 的 Javadoc 可執行檔。當 null 時，將使用目前 JVM 的 Javadoc 可執行檔，或從已設定的工具鏈取得。

failOnError

指定在 Javadoc 產生期間遇到錯誤時，此任務是否應失敗。當 true 時，此任務將在 Javadoc 錯誤時失敗。當 false 時，此任務將忽略 Javadoc 錯誤。

includes

包含模式的集合。

javadocTool

設定用於產生 javadoc 文件的 javadoc 可執行檔。

maxMemory

分配給此任務的記憶體量。

modularity

此 javadoc 任務的模組路徑處理。

options

Javadoc 產生選項。

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

用於解析原始碼中類型參考的類別路徑。

使用 java 外掛的預設值
project.sourceSets.main.compileClasspath

File destinationDir

產生文件至其中的目錄。

使用 java 外掛的預設值
${project.docsDir}/javadoc

Set<String> excludes

排除模式的集合。

String executable

用於產生 Javadoc 的 Javadoc 可執行檔。當 null 時，將使用目前 JVM 的 Javadoc 可執行檔，或從已設定的工具鏈取得。

使用 java 外掛的預設值
null

boolean failOnError

指定在 Javadoc 產生期間遇到錯誤時，此任務是否應失敗。當 true 時，此任務將在 Javadoc 錯誤時失敗。當 false 時，此任務將忽略 Javadoc 錯誤。

使用 java 外掛的預設值
true

Set<String> includes

包含模式的集合。

Property<JavadocTool> javadocTool

設定用於產生 javadoc 文件的 javadoc 可執行檔。

使用 java 外掛的預設值
java.toolchain

String maxMemory

分配給此任務的記憶體量。

使用 java 外掛的預設值
null

ModularitySpec modularity (唯讀)

此 javadoc 任務的模組路徑處理。

MinimalJavadocOptions options (唯讀)

Javadoc 產生選項。

FileTree source (唯讀)

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

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

使用 java 外掛的預設值
project.sourceSets.main.allJava

String title

產生文件的標題。

使用 java 外掛的預設值
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[]) 進行評估。