CLI

如果出於某種原因你無法使用 Gradle 或 Maven 建置工具，Dokka 提供了一個命令列 (CLI) 執行器來產生文件。

相比之下，它具有與 Dokka 的 Gradle 外掛程式相同（甚至更多）的功能。儘管由於沒有自動配置，設定起來會困難得多，特別是在多平台和多模組環境中。

快速入門

CLI 執行器以單獨的可執行構件形式發佈到 Maven Central。

將 dokka-cli-2.1.0.jar 檔案儲存在你的電腦上後，使用 -help 選項執行它以查看所有可用的配置選項及其描述：

Bash

java -jar dokka-cli-2.1.0.jar -help

它也適用於某些解除嵌套的選項，例如 -sourceSet：

Bash

java -jar dokka-cli-2.1.0.jar -sourceSet -help

產生文件

先決條件

由於沒有建置工具來管理相依性，你必須自行提供相依性的 .jar 檔案。

以下是任何輸出格式都需要的相依性：

Group	Artifact	Version	Link
`org.jetbrains.dokka`	`dokka-base`	2.1.0	下載
`org.jetbrains.dokka`	`analysis-kotlin-descriptors`	2.1.0	下載

以下是 HTML 輸出格式所需的額外相依性：

Group	Artifact	Version	Link
`org.jetbrains.kotlinx`	`kotlinx-html-jvm`	0.8.0	下載
`org.freemarker`	`freemarker`	2.3.31	下載

使用命令列選項執行

你可以傳遞命令列選項來配置 CLI 執行器。

你至少需要提供以下選項：

-pluginsClasspath - 下載的相依性之絕對／相對路徑清單，以分號 ; 分隔
-sourceSet - 要為其產生文件的原始碼絕對路徑
-outputDir - 文件輸出目錄的絕對／相對路徑

Bash

java -jar dokka-cli-2.1.0.jar \
     -pluginsClasspath "./dokka-base-2.1.0.jar;./analysis-kotlin-descriptors-2.1.0.jar;./kotlinx-html-jvm-0.8.0.jar;./freemarker-2.3.31.jar" \
     -sourceSet "-src /home/myCoolProject/src/main/kotlin" \
     -outputDir "./dokka/html"

執行給定的範例會產生 HTML 輸出格式的文件。

有關更多配置詳細資訊，請參閱命令列選項。

使用 JSON 配置執行

可以使用 JSON 配置 CLI 執行器。在這種情況下，你需要提供 JSON 配置檔案的絕對／相對路徑作為第一個且唯一的引數。所有其他配置選項都將從中剖析。

Bash

java -jar dokka-cli-2.1.0.jar dokka-configuration.json

你至少需要以下 JSON 配置檔案：

json

{
  "outputDir": "./dokka/html",
  "sourceSets": [
    {
      "sourceSetID": {
        "scopeId": "moduleName",
        "sourceSetName": "main"
      },
      "sourceRoots": [
        "/home/myCoolProject/src/main/kotlin"
      ]
    }
  ],
  "pluginsClasspath": [
    "./dokka-base-2.1.0.jar",
    "./kotlinx-html-jvm-0.8.0.jar",
    "./analysis-kotlin-descriptors-2.1.0.jar",
    "./freemarker-2.3.31.jar"
  ]
}

有關更多詳細資訊，請參閱 JSON 配置選項。

其他輸出格式

預設情況下，dokka-base 構件僅包含 HTML 輸出格式。

所有其他輸出格式都實作為 Dokka 外掛程式。為了使用它們，你必須將它們放入外掛程式類別路徑中。

例如，如果你想產生實驗性的 GFM 輸出格式的文件，你需要下載並將 gfm-plugin 的 JAR（下載）傳遞到 pluginsClasspath 配置選項中。

透過命令列選項：

Shell

java -jar dokka-cli-2.1.0.jar \
     -pluginsClasspath "./dokka-base-2.1.0.jar;...;./gfm-plugin-2.1.0.jar" \
     ...

透過 JSON 配置：

json

{
  ...
  "pluginsClasspath": [
    "./dokka-base-2.1.0.jar",
    "...",
    "./gfm-plugin-2.1.0.jar"
  ],
  ...
}

將 GFM 外掛程式傳遞給 pluginsClasspath 後，CLI 執行器會以 GFM 輸出格式產生文件。

欲了解更多資訊，請參閱 GFM 和 Javadoc 頁面。

命令列選項

要查看所有可能的命令列選項清單及其詳細說明，請執行：

Bash

java -jar dokka-cli-2.1.0.jar -help

簡短摘要：

選項	描述
`moduleName`	專案／模組的名稱。
`moduleVersion`	記錄文件的版本。
`outputDir`	輸出目錄路徑，預設為 `./dokka`。
`sourceSet`	Dokka 原始碼集的配置。包含嵌套的配置選項。
`pluginsConfiguration`	Dokka 外掛程式的配置。
`pluginsClasspath`	包含 Dokka 外掛程式及其相依性的 JAR 清單。接受以分號分隔的多個路徑。
`offlineMode`	是否透過網路解析遠端檔案／連結。
`failOnWarning`	當 Dokka 發出警告或錯誤時，是否讓文件產生失敗。
`delayTemplateSubstitution`	是否延遲某些元素的替換。用於多模組專案的增量建置。
`noSuppressObviousFunctions`	是否隱藏顯而易見的函式，例如繼承自 `kotlin.Any` 和 `java.lang.Object` 的函式。
`includes`	包含模組和套件文件的 Markdown 檔案。接受以分號分隔的多個值。
`suppressInheritedMembers`	是否隱藏在指定類別中未明確覆寫的繼承成員。
`globalPackageOptions`	套件配置選項的全域清單，格式為 `"matchingRegex,-deprecated,-privateApi,+warnUndocumented,+suppress;+visibility:PUBLIC;..."`。接受以分號分隔的多個值。
`globalLinks`	格式為 `{url}^{packageListUrl}` 的全域外部文件連結。接受以 `^^` 分隔的多個值。
`globalSrcLink`	原始碼目錄與用於瀏覽程式碼的 Web 服務之間的全域對應。接受以分號分隔的多個路徑。
`helpSourceSet`	列印解除嵌套的 `-sourceSet` 配置的說明。
`loggingLevel`	記錄層級，可能的值：`DEBUG, PROGRESS, INFO, WARN, ERROR`。
`help, h`	使用資訊。

原始碼集選項

要查看解除嵌套的 -sourceSet 配置的命令列選項清單，請執行：

Bash

java -jar dokka-cli-2.1.0.jar -sourceSet -help

簡短摘要：

選項	描述
`sourceSetName`	原始碼集的名稱。
`displayName`	原始碼集的顯示名稱，用於內部和外部。
`classpath`	用於分析和互動式範例的類別路徑。接受以分號分隔的多個路徑。
`src`	要進行分析和記錄文件的原始碼根目錄。接受以分號分隔的多個路徑。
`dependentSourceSets`	格式為 `moduleName/sourceSetName` 的相依原始碼集名稱。接受以分號分隔的多個值。
`samples`	包含範例函式的目錄或檔案清單。接受以分號分隔的多個路徑。
`includes`	包含模組和套件文件的 Markdown 檔案。接受以分號分隔的多個路徑。
`documentedVisibilities`	要記錄文件的可見性。接受以分號分隔的多個值。可能的值：`PUBLIC`、`PRIVATE`、`PROTECTED`、`INTERNAL`、`PACKAGE`。
`reportUndocumented`	是否報告未記錄文件的宣告。
`noSkipEmptyPackages`	是否為空套件建立頁面。
`skipDeprecated`	是否跳過已棄用的宣告。
`jdkVersion`	用於連結到 JDK Javadocs 的 JDK 版本。
`languageVersion`	用於設定分析和範例的語言版本。
`apiVersion`	用於設定分析和範例的 Kotlin API 版本。
`noStdlibLink`	是否產生指向 Kotlin 標準函式庫的連結。
`noJdkLink`	是否產生指向 JDK Javadocs 的連結。
`suppressedFiles`	要隱藏的檔案路徑。接受以分號分隔的多個路徑。
`suppressAnnotatedWith`	用於隱藏標記有該註解之宣告的註解完全限定名稱 (FQN)。接受以分號分隔的多個值。
`analysisPlatform`	用於設定分析的平台。
`perPackageOptions`	格式為 `matchingRegexp,-deprecated,-privateApi,+warnUndocumented,+suppress;...` 的套件原始碼集配置清單。接受以分號分隔的多個值。
`externalDocumentationLinks`	格式為 `{url}^{packageListUrl}` 的外部文件連結。接受以 `^^` 分隔的多個值。
`srcLink`	原始碼目錄與用於瀏覽程式碼的 Web 服務之間的對應。接受以分號分隔的多個路徑。

JSON 配置

以下是每個配置部分的範例和詳細描述。你也可以在頁面底部找到應用了所有配置選項的範例。

一般配置

json

{
  "moduleName": "Dokka Example",
  "moduleVersion": null,
  "outputDir": "./build/dokka/html",
  "failOnWarning": false,
  "suppressObviousFunctions": true,
  "suppressInheritedMembers": false,
  "offlineMode": false,
  "includes": [
    "module.md"
  ],
  "sourceLinks":  [
    { "_comment": "選項在單獨的部分中描述" }
  ],
  "perPackageOptions": [
    { "_comment": "選項在單獨的部分中描述" }
  ],
  "externalDocumentationLinks":  [
    { "_comment": "選項在單獨的部分中描述" }
  ],
  "sourceSets": [
    { "_comment": "選項在單獨的部分中描述" }
  ],
  "pluginsClasspath": [
    "./dokka-base-2.1.0.jar",
    "./kotlinx-html-jvm-0.8.0.jar",
    "./analysis-kotlin-descriptors-2.1.0.jar",
    "./freemarker-2.3.31.jar"
  ]
}

moduleName

用於引用模組的顯示名稱。它用於目錄、導覽、記錄等。

預設值：root

moduleVersion

模組版本。

預設值：空

outputDirectory

無論輸出格式為何，產生文件的目錄。

預設值：./dokka

failOnWarning

當 Dokka 發出警告或錯誤時，是否讓文件產生失敗。該過程會等待所有錯誤和警告都發出後才停止。

此設定與 reportUndocumented 配合良好

預設值：false

suppressObviousFunctions

是否隱藏顯而易見的函式。

如果函式滿足以下條件，則被視為顯而易見：

繼承自 kotlin.Any、Kotlin.Enum、java.lang.Object 或 java.lang.Enum，例如 equals、hashCode、toString。
合成的（由編譯器產生）且沒有任何文件，例如 dataClass.componentN 或 dataClass.copy。

預設值：true

suppressInheritedMembers

是否隱藏在指定類別中未明確覆寫的繼承成員。

注意：這可以隱藏諸如 equals / hashCode / toString 之類的函式，但不能隱藏諸如 dataClass.componentN 和 dataClass.copy 之類的合成函式。請使用 suppressObviousFunctions 來處理。

預設值：false

offlineMode

是否透過網路解析遠端檔案／連結。

這包括用於產生外部文件連結的 package-list。例如，讓來自標準函式庫的類別可以點擊。

在某些情況下，將此設定為 true 可以顯著提高建置速度，但也可能降低文件品質和使用者體驗。例如，無法解析來自相依性（包括標準函式庫）的類別／成員連結。

注意：你可以將抓取的檔案快取到本機，並將其作為本機路徑提供給 Dokka。請參閱 externalDocumentationLinks 部分。

預設值：false

includes

包含模組和套件文件的 Markdown 檔案清單。

指定檔案的內容會被剖析並作為模組和套件描述嵌入到文件中。

這可以針對每個套件進行配置。

sourceSets

Kotlin 原始碼集的個別和額外配置。

有關可能選項的清單，請參閱原始碼集配置。

sourceLinks

套用於所有原始碼集的原始碼連結全域配置。

有關可能選項的清單，請參閱原始碼連結配置。

perPackageOptions

相符套件的全域配置，無論它們位於哪個原始碼集中。

有關可能選項的清單，請參閱每個套件的配置。

externalDocumentationLinks

外部文件連結的全域配置，無論它們在哪個原始碼集中被使用。

有關 possible 選項的清單，請參閱外部文件連結配置。

pluginsClasspath

包含 Dokka 外掛程式及其相依性的 JAR 檔案清單。

原始碼集配置

如何配置 Kotlin 原始碼集：

json

{
  "sourceSets": [
    {
      "displayName": "jvm",
      "sourceSetID": {
        "scopeId": "moduleName",
        "sourceSetName": "main"
      },
      "dependentSourceSets": [
        {
          "scopeId": "dependentSourceSetScopeId",
          "sourceSetName": "dependentSourceSetName"
        }
      ],
      "documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"],
      "reportUndocumented": false,
      "skipEmptyPackages": true,
      "skipDeprecated": false,
      "jdkVersion": 8,
      "languageVersion": "1.7",
      "apiVersion": "1.7",
      "noStdlibLink": false,
      "noJdkLink": false,
      "includes": [
        "module.md"
      ],
      "analysisPlatform": "jvm",
      "sourceRoots": [
        "/home/ignat/IdeaProjects/dokka-debug-mvn/src/main/kotlin"
      ],
      "classpath": [
        "libs/kotlin-stdlib-2.3.0.jar",
        "libs/kotlin-stdlib-common-2.3.0.jar"
      ],
      "samples": [
        "samples/basic.kt"
      ],
      "suppressedFiles": [
        "src/main/kotlin/org/jetbrains/dokka/Suppressed.kt"
      ],
      "sourceLinks":  [
        { "_comment": "選項在單獨的部分中描述" }
      ],
      "perPackageOptions": [
        { "_comment": "選項在單獨的部分中描述" }
      ],
      "externalDocumentationLinks":  [
        { "_comment": "選項在單獨的部分中描述" }
      ]
    }
  ]
}

displayName

用於引用此原始碼集的顯示名稱。

此名稱既用於外部（例如，原始碼集名稱對文件閱讀者可見），也用於內部（例如，用於 reportUndocumented 的記錄訊息）。

如果你沒有更好的選擇，可以使用平台名稱。

sourceSetID

原始碼集的技術 ID

documentedVisibilities

應記錄文件的可見性修飾符集合。

如果你想記錄 protected/internal/private 宣告，以及如果你想排除 public 宣告並僅記錄內部 API，則可以使用此選項。

這可以針對每個套件進行配置。

可能的值：

PUBLIC
PRIVATE
PROTECTED
INTERNAL
PACKAGE

預設值：PUBLIC

reportUndocumented

是否發出關於可見的未記錄文件宣告的警告，即在被 documentedVisibilities 和其他篩選器篩選後沒有 KDocs 的宣告。

此設定與 failOnWarning 配合良好。

這可以針對每個套件進行配置。

預設值：false

skipEmptyPackages

在應用各種篩選器後，是否跳過不含可見宣告的套件。

例如，如果 skipDeprecated 設定為 true 且你的套件僅包含已棄用的宣告，則該套件被視為空套件。

CLI 執行器的預設值為 false。

skipDeprecated

是否記錄使用 @Deprecated 註解的宣告。

這可以針對每個套件進行配置。

預設值：false

jdkVersion

為 Java 型別產生外部文件連結時使用的 JDK 版本。

例如，如果你在某些公用宣告簽章中使用 java.util.UUID，且此選項設定為 8，Dokka 會為其產生指向 JDK 8 Javadocs 的外部文件連結。

languageVersion

用於設定分析和 @sample 環境的 Kotlin 語言版本。

apiVersion

用於設定分析 and @sample 環境的 Kotlin API 版本。

noStdlibLink

是否產生指向 Kotlin 標準函式庫 API 參考文件的外部文件連結。

注意：當 noStdLibLink 設定為 false 時，會產生連結。

預設值：false

noJdkLink

是否產生指向 JDK Javadocs 的外部文件連結。

JDK Javadocs 的版本由 jdkVersion 選項決定。

注意：當 noJdkLink 設定為 false 時，會產生連結。

預設值：false

includes

包含模組和套件文件的 Markdown 檔案清單。

指定檔案的內容會被剖析並作為模組和套件描述嵌入到文件中。

analysisPlatform

用於設定程式碼分析和 @sample 環境的平台。

可能的值：

jvm
common
js
native

sourceRoots

要進行分析和記錄文件的原始碼根目錄。可接受的輸入包括目錄和個別的 .kt / .java 檔案。

classpath

用於分析和互動式範例的類別路徑。

如果某些來自相依性的型別未被自動解析／選取，這將非常有用。

此選項接受 .jar 和 .klib 檔案。

samples

包含範例函式的目錄或檔案清單，這些範例函式透過 @sample KDoc 標籤被引用。

suppressedFiles

產生文件時要隱藏的檔案。

suppressAnnotatedWith

用於隱藏標記有該註解之宣告的註解完全限定名稱 (FQN) 清單。

任何標記有這些註解之一的宣告都將從產生的文件中排除。

sourceLinks

僅套用於此原始碼集的原始碼連結參數集合。

有關可能選項的清單，請參閱原始碼連結配置。

perPackageOptions

特定於此原始碼集內相符套件的參數集合。

有關可能選項的清單，請參閱每個套件的配置。

externalDocumentationLinks

僅套用於此原始碼集的外部文件連結參數集合。

有關可能選項的清單，請參閱外部文件連結配置。

原始碼連結配置

sourceLinks 配置區塊允許你為每個簽章新增一個 source 連結，該連結指向具有特定行號的 remoteUrl。（行號可以透過設定 remoteLineSuffix 來配置）。

這有助於讀者找到每個宣告的原始碼。

例如，請參閱 kotlinx.coroutines 中 count() 函式的文件。

你可以同時為所有原始碼集配置原始碼連結，也可以個別配置：

json

{
  "sourceLinks": [
    {
      "localDirectory": "src/main/kotlin",
      "remoteUrl": "https://github.com/Kotlin/dokka/tree/master/src/main/kotlin",
      "remoteLineSuffix": "#L"
    }
  ]
}

localDirectory

本機原始碼目錄的路徑。

remoteUrl

文件讀者可以存取的原始碼代管服務的 URL，例如 GitHub、GitLab、Bitbucket 等。此 URL 用於產生宣告的原始碼連結。

remoteLineSuffix

用於將原始碼行號附加到 URL 的後置字串。這有助於讀者不僅導向檔案，還能導向宣告的具體行號。

數字本身會附加到指定的後置字串。例如，如果此選項設定為 #L 且行號為 10，則產生的 URL 後置字串為 #L10。

常用服務使用的後置字串：

GitHub: #L
GitLab: #L
Bitbucket: #lines-

預設值：空（無後置字串）

每個套件的配置

perPackageOptions 配置區塊允許為與 matchingRegex 相符的特定套件設定某些選項。

你可以同時為所有原始碼集新增套件配置，也可以個別配置：

json

{
  "perPackageOptions": [
    {
      "matchingRegex": ".*internal.*",
      "suppress": false,
      "skipDeprecated": false,
      "reportUndocumented": false,
      "documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"]
    }
  ]
}

matchingRegex

用於比對套件的正規表示式。

suppress

產生文件時是否應跳過此套件。

預設值：false

skipDeprecated

是否記錄使用 @Deprecated 註解的宣告。

這可以在專案／模組層級設定。

預設值：false

reportUndocumented

是否發出關於可見的未記錄文件宣告的警告，即在被 documentedVisibilities 和其他篩選器篩選後沒有 KDocs 的宣告。

此設定與 failOnWarning 配合良好。

這可以在原始碼集層級進行配置。

預設值：false

documentedVisibilities

應記錄文件的可見性修飾符集合。

如果你想記錄此套件內的 protected/internal/private 宣告，以及如果你想排除 public 宣告並僅記錄內部 API，則可以使用此選項。

可以在原始碼集層級進行配置。

預設值：PUBLIC

外部文件連結配置

externalDocumentationLinks 區塊允許建立指向相依性之外部代管文件的連結。

例如，如果你正在使用來自 kotlinx.serialization 的型別，預設情況下它們在你的文件中是不可點擊的，就好像它們未解析一樣。但是，由於 kotlinx.serialization 的 API 參考文件是由 Dokka 建置並發佈在 kotlinlang.org 上，你可以為其配置外部文件連結。從而允許 Dokka 為程式庫中的型別產生連結，使其成功解析並可點擊。

你可以同時為所有原始碼集配置外部文件連結，也可以個別配置：

json

{
  "externalDocumentationLinks": [
    {
      "url": "https://kotlinlang.org/api/kotlinx.serialization/",
      "packageListUrl": "https://kotlinlang.org/api/kotlinx.serialization/package-list"
    }
  ]
}

url

要連結的文件根 URL。它必須以斜杠結尾。

Dokka 會盡力自動尋找指定 URL 的 package-list，並將宣告連結在一起。

如果自動解析失敗，或者如果你想改用本機快取的檔案，請考慮設定 packageListUrl 選項。

packageListUrl

package-list 的確切位置。這是依靠 Dokka 自動解析之外的另一種選擇。

套件清單包含有關文件和專案本身的資訊，例如模組和套件名稱。

這也可以是本機快取的檔案，以避免網路呼叫。

完整配置

下面你可以看到同時應用的所有可能配置選項。

json

{
  "moduleName": "Dokka Example",
  "moduleVersion": null,
  "outputDir": "./build/dokka/html",
  "failOnWarning": false,
  "suppressObviousFunctions": true,
  "suppressInheritedMembers": false,
  "offlineMode": false,
  "suppressAnnotatedWith": [
    "com.example.SuppressMe"
  ],
  "sourceLinks": [
    {
      "localDirectory": "src/main/kotlin",
      "remoteUrl": "https://github.com/Kotlin/dokka/tree/master/src/main/kotlin",
      "remoteLineSuffix": "#L"
    }
  ],
  "externalDocumentationLinks": [
    {
      "url": "https://docs.oracle.com/javase/8/docs/api/",
      "packageListUrl": "https://docs.oracle.com/javase/8/docs/api/package-list"
    },
    {
      "url": "https://kotlinlang.org/api/core/kotlin-stdlib/",
      "packageListUrl": "https://kotlinlang.org/api/core/kotlin-stdlib/package-list"
    }
  ],
  "perPackageOptions": [
    {
      "matchingRegex": ".*internal.*",
      "suppress": false,
      "reportUndocumented": false,
      "skipDeprecated": false,
      "documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"]
    }
  ],
  "sourceSets": [
    {
      "displayName": "jvm",
      "sourceSetID": {
        "scopeId": "moduleName",
        "sourceSetName": "main"
      },
      "dependentSourceSets": [
        {
          "scopeId": "dependentSourceSetScopeId",
          "sourceSetName": "dependentSourceSetName"
        }
      ],
      "documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"],
      "reportUndocumented": false,
      "skipEmptyPackages": true,
      "skipDeprecated": false,
      "jdkVersion": 8,
      "languageVersion": "1.7",
      "apiVersion": "1.7",
      "noStdlibLink": false,
      "noJdkLink": false,
      "includes": [
        "module.md"
      ],
      "analysisPlatform": "jvm",
      "sourceRoots": [
        "/home/ignat/IdeaProjects/dokka-debug-mvn/src/main/kotlin"
      ],
      "classpath": [
        "libs/kotlin-stdlib-2.3.0.jar",
        "libs/kotlin-stdlib-common-2.3.0.jar"
      ],
      "samples": [
        "samples/basic.kt"
      ],
      "suppressedFiles": [
        "src/main/kotlin/org/jetbrains/dokka/Suppressed.kt"
      ],
      "suppressAnnotatedWith": [
        "com.example.SuppressMe"
      ],
      "sourceLinks": [
        {
          "localDirectory": "src/main/kotlin",
          "remoteUrl": "https://github.com/Kotlin/dokka/tree/master/src/main/kotlin",
          "remoteLineSuffix": "#L"
        }
      ],
      "externalDocumentationLinks": [
        {
          "url": "https://docs.oracle.com/javase/8/docs/api/",
          "packageListUrl": "https://docs.oracle.com/javase/8/docs/api/package-list"
        },
        {
          "url": "https://kotlinlang.org/api/core/kotlin-stdlib/",
          "packageListUrl": "https://kotlinlang.org/api/core/kotlin-stdlib/package-list"
        }
      ],
      "perPackageOptions": [
        {
          "matchingRegex": ".*internal.*",
          "suppress": false,
          "reportUndocumented": false,
          "skipDeprecated": false,
          "documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"]
        }
      ]
    }
  ],
  "pluginsClasspath": [
    "./dokka-base-2.1.0.jar",
    "./kotlinx-html-jvm-0.8.0.jar",
    "./analysis-kotlin-descriptors-2.1.0.jar",
    "./freemarker-2.3.31.jar"
  ],
  "pluginsConfiguration": [
    {
      "fqPluginName": "org.jetbrains.dokka.base.DokkaBase",
      "serializationFormat": "JSON",
      "values": "{\"separateInheritedMembers\":false,\"footerMessage\":\"© 2021 pretty good Copyright\"}"
    }
  ],
  "includes": [
    "module.md"
  ]
}

執行 Dokka

輸出格式

檢索

操作與運算子

CLI ​

快速入門 ​

產生文件 ​

先決條件 ​

使用命令列選項執行 ​

使用 JSON 配置執行 ​

其他輸出格式 ​

命令列選項 ​

原始碼集選項 ​

JSON 配置 ​

一般配置 ​

原始碼集配置 ​

原始碼連結配置 ​

每個套件的配置 ​

外部文件連結配置 ​

完整配置 ​

CLI

快速入門

產生文件

先決條件

使用命令列選項執行

使用 JSON 配置執行

其他輸出格式

命令列選項

原始碼集選項

JSON 配置

一般配置

原始碼集配置

原始碼連結配置

每個套件的配置

外部文件連結配置

完整配置