CLI
何らかの理由でGradleまたはMavenビルドツールを使用できない場合、Dokkaにはドキュメント生成用のコマンドライン(CLI)ランナーが用意されています。
比較すると、DokkaのGradleプラグインと同等、あるいはそれ以上の機能を備えています。ただし、自動設定がないため、特にマルチプラットフォーム環境やマルチモジュール環境ではセットアップがかなり難しくなります。
はじめに
CLIランナーは、実行可能な個別アーティファクトとしてMaven Centralに公開されています。
Maven Centralで見つけるか、直接ダウンロードできます。
コンピュータに保存した dokka-cli-2.2.0.jar ファイルで、-help オプションを指定して実行すると、利用可能なすべての設定オプションとその説明が表示されます。
java -jar dokka-cli-2.2.0.jar -helpこれは、-sourceSet などの一部のネストされたオプションでも機能します。
java -jar dokka-cli-2.2.0.jar -sourceSet -helpドキュメントの生成
前提条件
依存関係を管理するビルドツールがないため、依存関係の .jar ファイルを自身で用意する必要があります。
任意の出力フォーマットで必要となる依存関係は以下のとおりです。
| Group | Artifact | Version | Link |
|---|---|---|---|
org.jetbrains.dokka | dokka-base | 2.2.0 | download |
org.jetbrains.dokka | analysis-kotlin-symbols | 2.2.0 | download |
HTML出力フォーマットで追加で必要となる依存関係は以下のとおりです。
| Group | Artifact | Version | Link |
|---|---|---|---|
org.jetbrains.kotlinx | kotlinx-html-jvm | 0.8.0 | download |
org.freemarker | freemarker | 2.3.31 | download |
コマンドラインオプションを指定して実行する
コマンドラインオプションを渡してCLIランナーを設定できます。
最低限、以下のオプションを指定する必要があります。
-pluginsClasspath- セミコロン;で区切られた、ダウンロードした依存関係への絶対パス/相対パスのリスト-sourceSet- ドキュメントを生成するソースコードへの絶対パス-outputDir- ドキュメント出力ディレクトリの絶対パス/相対パス
java -jar dokka-cli-2.2.0.jar \
-pluginsClasspath "./dokka-base-2.2.0.jar;./analysis-kotlin-symbols-2.2.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設定ファイルを使用して実行する
CLIランナーはJSONで設定することも可能です。この場合、最初で唯一の引数としてJSON設定ファイルへの絶対パスまたは相対パスを指定する必要があります。その他のすべての設定オプションは、そこからパース(解析)されます。
java -jar dokka-cli-2.2.0.jar dokka-configuration.json最低限、以下のようなJSON設定ファイルが必要です。
{
"outputDir": "./dokka/html",
"sourceSets": [
{
"sourceSetID": {
"scopeId": "moduleName",
"sourceSetName": "main"
},
"sourceRoots": [
"/home/myCoolProject/src/main/kotlin"
]
}
],
"pluginsClasspath": [
"./dokka-base-2.2.0.jar",
"./kotlinx-html-jvm-0.8.0.jar",
"./analysis-kotlin-symbols-2.2.0.jar",
"./freemarker-2.3.31.jar"
]
}詳細については、JSON設定オプションを参照してください。
その他の出力フォーマット
デフォルトでは、dokka-base アーティファクトにはHTML出力フォーマットのみが含まれています。
その他の出力フォーマットはすべてDokkaプラグインとして実装されています。これらを使用するには、プラグインのクラスパスに配置する必要があります。
たとえば、実験的なGFM出力フォーマットでドキュメントを生成したい場合は、gfm-pluginのJAR(ダウンロード)をダウンロードし、pluginsClasspath 設定オプションに渡す必要があります。
コマンドラインオプションの場合:
java -jar dokka-cli-2.2.0.jar \
-pluginsClasspath "./dokka-base-2.2.0.jar;...;./gfm-plugin-2.2.0.jar" \
...JSON設定の場合:
{
...
"pluginsClasspath": [
"./dokka-base-2.2.0.jar",
"...",
"./gfm-plugin-2.2.0.jar"
],
...
}GFMプラグインを pluginsClasspath に渡すことで、CLIランナーはGFM出力フォーマットでドキュメントを生成します。
詳細については、GFMおよびJavadocのページを参照してください。
コマンドラインオプション
指定可能なすべてのコマンドラインオプションのリストと詳細な説明を表示するには、以下を実行します。
java -jar dokka-cli-2.2.0.jar -help簡単な概要:
| Option | Description |
|---|---|
moduleName | プロジェクト/モジュールの名前。 |
moduleVersion | ドキュメント化するバージョン。 |
outputDir | 出力ディレクトリパス。デフォルトは ./dokka。 |
sourceSet | Dokkaソースセットの設定。ネストされた設定オプションを含みます。 |
pluginsConfiguration | Dokkaプラグインの設定。 |
pluginsClasspath | Dokkaプラグインとその依存関係を含むjarのリスト。セミコロン区切りで複数のパスを受け入れます。 |
offlineMode | ネットワーク経由でリモートファイル/リンクを解決するかどうか。 |
failOnWarning | Dokkaが警告またはエラーを出力した場合に、ドキュメント生成を失敗させるかどうか。 |
delayTemplateSubstitution | 一部の要素の置換を遅延させるかどうか。マルチモジュールプロジェクトのインクリメンタルビルドで使用されます。 |
noSuppressObviousFunctions | kotlin.Any や java.lang.Object から継承された関数など、自明な関数(obvious functions)の抑制を行わないかどうか。 |
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 設定のコマンドラインオプションのリストを表示するには、以下を実行します。
java -jar dokka-cli-2.2.0.jar -sourceSet -help簡単な概要:
| Option | Description |
|---|---|
sourceSetName | ソースセットの名前。 |
displayName | 内部および外部の両方で使用される、ソースセットの表示名。 |
classpath | 解析およびインタラクティブなサンプルのためのクラスパス。セミコロン区切りで複数のパスを受け入れます。 |
src | 解析およびドキュメント化の対象となるソースコードのルート。セミコロン区切りで複数のパスを受け入れます。 |
dependentSourceSets | moduleName/sourceSetName 形式の依存ソースセットの名前。セミコロン区切りで複数の値を受け入れます。 |
samples | サンプル関数を含むディレクトリまたはファイルのリスト。セミコロン区切りで複数のパスを受け入れます。 |
includes | モジュールおよびパッケージドキュメントを含むMarkdownファイル。セミコロン区切りで複数のパスを受け入れます。 |
documentedVisibilities | ドキュメント化する可視性(Visibility)。セミコロン区切りで複数の値を受け入れます。指定可能な値: PUBLIC、PRIVATE、PROTECTED、INTERNAL、PACKAGE。 |
reportUndocumented | ドキュメント化されていない宣言を報告するかどうか。 |
noSkipEmptyPackages | 空のパッケージに対してもページを作成するかどうか。 |
skipDeprecated | 非推奨(deprecated)の宣言をスキップするかどうか。 |
jdkVersion | JDK Javadocへのリンクに使用するJDKのバージョン。 |
languageVersion | 解析およびサンプルのセットアップに使用される言語バージョン。 |
apiVersion | 解析およびサンプルのセットアップに使用されるKotlin APIバージョン。 |
noStdlibLink | Kotlin標準ライブラリへのリンクを生成しないかどうか。 |
noJdkLink | JDK Javadocへのリンクを生成しないかどうか。 |
suppressedFiles | 抑制するファイルのパス。セミコロン区切りで複数のパスを受け入れます。 |
suppressAnnotatedWith | アノテーションが付与された宣言を抑制するための、アノテーションの完全修飾名(FQN)。セミコロン区切りで複数の値を受け入れます。 |
analysisPlatform | 解析のセットアップに使用されるプラットフォーム。 |
perPackageOptions | matchingRegexp,-deprecated,-privateApi,+warnUndocumented,+suppress;... 形式のパッケージソースセット設定のリスト。セミコロン区切りで複数の値を受け入れます。 |
externalDocumentationLinks | {url}^{packageListUrl} 形式の外部ドキュメントリンク。^^ 区切りで複数の値を受け入れます。 |
srcLink | ソースディレクトリとコードを閲覧するためのWebサービス間のマッピング。セミコロン区切りで複数のパスを受け入れます。 |
JSON設定
以下に、各設定セクションの例と詳細な説明を示します。また、ページ下部にはすべての設定オプションを適用した例も掲載しています。
全般設定
{
"moduleName": "Dokka Example",
"moduleVersion": null,
"outputDir": "./build/dokka/html",
"failOnWarning": false,
"suppressObviousFunctions": true,
"suppressInheritedMembers": false,
"offlineMode": false,
"includes": [
"module.md"
],
"sourceLinks": [
{ "_comment": "Options are described in a separate section" }
],
"perPackageOptions": [
{ "_comment": "Options are described in a separate section" }
],
"externalDocumentationLinks": [
{ "_comment": "Options are described in a separate section" }
],
"sourceSets": [
{ "_comment": "Options are described in a separate section" }
],
"pluginsClasspath": [
"./dokka-base-2.2.0.jar",
"./kotlinx-html-jvm-0.8.0.jar",
"./analysis-kotlin-symbols-2.2.0.jar",
"./freemarker-2.3.31.jar"
]
}moduleName
モジュールを参照するために使用される表示名です。目次、ナビゲーション、ロギングなどに使用されます。
デフォルト: root
moduleVersion
モジュールのバージョンです。
デフォルト: 空
outputDirectory
出力フォーマットに関係なく、ドキュメントが生成されるディレクトリです。
デフォルト: ./dokka
failOnWarning
Dokkaが警告またはエラーを出力した場合に、ドキュメント生成を失敗させるかどうかです。 処理は、まずすべてのエラーと警告が出力されるまで待機します。
この設定は reportUndocumented と相性が良いです。
デフォルト: false
suppressObviousFunctions
自明な関数を抑制するかどうかです。
次のいずれかに該当する場合、関数は自明であるとみなされます。equals、hashCode、toStringなど、kotlin.Any、Kotlin.Enum、java.lang.Object、 またはjava.lang.Enumから継承されたもの。dataClass.componentNやdataClass.copyなど、合成(コンパイラによって生成)され、ドキュメントを持たないもの。
デフォルト: true
suppressInheritedMembers
特定のクラスで明示的にオーバーライドされていない継承メンバーを抑制するかどうかです。
注意: これは equals / hashCode / toString などの関数を抑制できますが、 dataClass.componentN や dataClass.copy などの合成関数は抑制できません。 それらには suppressObviousFunctions を使用してください。
デフォルト: false
offlineMode
ネットワーク経由でリモートファイル/リンクを解決するかどうかです。
これには、外部ドキュメントリンクの生成に使用される package-list が含まれます(たとえば標準ライブラリのクラスをクリック可能にするためなど)。
これを true に設定すると、場合によってはビルド時間を大幅に短縮できますが、 標準ライブラリを含む依存関係のクラス/メンバーリンクが解決されなくなるなど、ドキュメントの品質やユーザー体験が低下する可能性もあります。
注意: 取得したファイルをローカルにキャッシュし、ローカルパスとしてDokkaに提供することができます。 externalDocumentationLinks セクションを参照してください。
デフォルト: false
includes
モジュールおよびパッケージドキュメントを含むMarkdownファイルのリストです。
指定されたファイルの内容はパースされ、モジュールおよびパッケージの説明としてドキュメントに埋め込まれます。
これはパッケージ単位で設定できます。
sourceLinks
すべてのソースセットに適用されるソースリンクのグローバル設定です。
指定可能なオプションのリストについては、ソースリンク設定を参照してください。
perPackageOptions
属するソースセットに関係なく、一致するパッケージに対するグローバル設定です。
指定可能なオプションのリストについては、パッケージごとの設定を参照してください。
externalDocumentationLinks
使用されているソースセットに関係なく、外部ドキュメントリンクに対するグローバル設定です。
指定可能なオプションのリストについては、外部ドキュメントリンク設定を参照してください。
pluginsClasspath
Dokkaプラグインとその依存関係を含むJARファイルのリストです。
ソースセット設定
Kotlinのソースセットを設定する方法:
{
"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.4.21.jar",
"libs/kotlin-stdlib-common-2.4.21.jar"
],
"samples": [
"samples/basic.kt"
],
"suppressedFiles": [
"src/main/kotlin/org/jetbrains/dokka/Suppressed.kt"
],
"suppressAnnotatedWith": [
"com.example.SuppressMe"
],
"sourceLinks": [
{ "_comment": "Options are described in a separate section" }
],
"perPackageOptions": [
{ "_comment": "Options are described in a separate section" }
],
"externalDocumentationLinks": [
{ "_comment": "Options are described in a separate section" }
]
}
]
}displayName
このソースセットを参照するために使用される表示名です。
この名前は外部(ドキュメントの閲覧者にソースセット名が表示されるなど)と 内部(reportUndocumented のログメッセージなど)の両方で使用されます。
より適切な代替案がない場合は、プラットフォーム名を使用できます。
sourceSetID
ソースセットの技術的なIDです。
documentedVisibilities
ドキュメント化すべき可視性修飾子のセットです。
これは、protected/internal/private の宣言をドキュメント化したい場合や、 public の宣言を除外して内部APIのみをドキュメント化したい場合に使用できます。
パッケージ単位で設定可能です。
指定可能な値:
PUBLICPRIVATEPROTECTEDINTERNALPACKAGE
デフォルト: PUBLIC
reportUndocumented
documentedVisibilities やその他のフィルターによってフィルタリングされた後、可視であるにもかかわらずドキュメント化されていない宣言(KDocがない宣言)について警告を出力するかどうかです。
この設定は failOnWarning と相性が良いです。
パッケージ単位で設定可能です。
デフォルト: false
skipEmptyPackages
さまざまなフィルターが適用された後に、可視な宣言が含まれていないパッケージをスキップするかどうかです。
たとえば、skipDeprecated が true に設定されており、パッケージに非推奨の宣言しか含まれていない場合、そのパッケージは空であるとみなされます。
CLIランナーのデフォルトは false です。
skipDeprecated
@Deprecated が付与された宣言をドキュメント化するかどうかです。
パッケージ単位で設定可能です。
デフォルト: false
jdkVersion
Java型の外部ドキュメントリンクを生成する際に使用するJDKバージョンです。
たとえば、公開宣言のシグネチャで java.util.UUID を使用しており、このオプションが 8 に設定されている場合、Dokkaはその宣言に対して JDK 8 Javadoc への外部ドキュメントリンクを生成します。
languageVersion
解析および @sample 環境のセットアップに使用されるKotlin言語バージョンです。
apiVersion
解析および @sample 環境のセットアップに使用されるKotlin APIバージョンです。
noStdlibLink
Kotlin標準ライブラリのAPIリファレンスドキュメントへ導く外部ドキュメントリンクを生成するかどうかです。
注意: noStdLibLink が false に設定されている場合、リンクは生成されます。
デフォルト: false
noJdkLink
JDKのJavadocへの外部ドキュメントリンクを生成するかどうかです。
JDK Javadocのバージョンは jdkVersion オプションによって決定されます。
注意: noJdkLink が false に設定されている場合、リンクは生成されます。
デフォルト: false
includes
モジュールおよびパッケージドキュメントを含むMarkdownファイルのリストです。
指定されたファイルの内容はパースされ、モジュールおよびパッケージの説明としてドキュメントに埋め込まれます。
analysisPlatform
sourceRoots
解析およびドキュメント化の対象となるソースコードのルートです。 有効な入力はディレクトリおよび個別の .kt / .java ファイルです。
classpath
解析およびインタラクティブなサンプルのためのクラスパスです。
依存関係に由来する一部の型が自動的に解決/検出されない場合に便利です。
このオプションは .jar と .klib の両方のファイルを受け入れます。
samples
@sample KDocタグを介して参照されるサンプル関数を含むディレクトリまたはファイルのリストです。
suppressedFiles
ドキュメント生成時に抑制するファイルです。
suppressAnnotatedWith
アノテーションが付与された宣言を抑制するための、アノテーションの完全修飾名(FQN)のリストです。
これらのアノテーションのいずれかが付与されている宣言は、生成されるドキュメントから除外されます。
sourceLinks
このソースセットにのみ適用されるソースリンクのパラメータセットです。
指定可能なオプションのリストについては、ソースリンク設定を参照してください。
perPackageOptions
このソースセット内の一致するパッケージに固有のパラメータセットです。
指定可能なオプションのリストについては、パッケージごとの設定を参照してください。
externalDocumentationLinks
このソースセットにのみ適用される外部ドキュメントリンクのパラメータセットです。
指定可能なオプションのリストについては、外部ドキュメントリンク設定を参照してください。
ソースリンク設定
sourceLinks 設定ブロックを使用すると、各シグネチャに特定の行番号付きの remoteUrl へ導く source リンクを追加できます(行番号は remoteLineSuffix を設定して構成可能です)。
これにより、読者は各宣言のソースコードを見つけやすくなります。
例については、kotlinx.coroutines の count() 関数のドキュメントを参照してください。
ソースリンクはすべてのソースセットに対して一度にまとめて設定することも、個別に設定することもできます。
{
"sourceLinks": [
{
"localDirectory": "src/main/kotlin",
"remoteUrl": "https://github.com/Kotlin/dokka/tree/master/src/main/kotlin",
"remoteLineSuffix": "#L"
}
]
}localDirectory
ローカルのソースディレクトリへのパスです。
remoteUrl
GitHub、GitLab、Bitbucketなど、ドキュメントの閲覧者がアクセスできるソースコードホスティングサービスのURLです。このURLは、宣言のソースコードリンクを生成するために使用されます。
remoteLineSuffix
ソースコードの行番号をURLに追加するために使用されるサフィックスです。これにより、読者はファイルだけでなく、宣言の特定の行番号に移動できるようになります。
指定されたサフィックスの後ろに行番号自体が付加されます。たとえば、このオプションが #L に設定されており、行番号が 10 の場合、生成されるURLサフィックスは #L10 になります。
代表的なサービスで使用されるサフィックス:
- GitHub:
#L - GitLab:
#L - Bitbucket:
#lines-
デフォルト: 空(サフィックスなし)
パッケージごとの設定
perPackageOptions 設定ブロックを使用すると、matchingRegex に一致する特定のパッケージに対していくつかのオプションを設定できます。
パッケージ設定はすべてのソースセットに対して一度にまとめて追加することも、個別に追加することもできます。
{
"perPackageOptions": [
{
"matchingRegex": ".*internal.*",
"suppress": false,
"skipDeprecated": false,
"reportUndocumented": false,
"documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"]
}
]
}matchingRegex
パッケージのマッチングに使用される正規表現です。
suppress
ドキュメント生成時にこのパッケージをスキップするかどうかです。
デフォルト: false
skipDeprecated
@Deprecated が付与された宣言をドキュメント化するかどうかです。
プロジェクト/モジュールレベルで設定可能です。
デフォルト: false
reportUndocumented
documentedVisibilities やその他のフィルターによってフィルタリングされた後、可視であるにもかかわらずドキュメント化されていない宣言(KDocがない宣言)について警告を出力するかどうかです。
この設定は failOnWarning と相性が良いです。
ソースセットレベルで設定可能です。
デフォルト: false
documentedVisibilities
ドキュメント化すべき可視性修飾子のセットです。
これは、このパッケージ内の protected/internal/private の宣言をドキュメント化したい場合や、public の宣言を除外して内部APIのみをドキュメント化したい場合に使用できます。
ソースセットレベルで設定可能です。
デフォルト: PUBLIC
外部ドキュメントリンク設定
externalDocumentationLinks ブロックを使用すると、依存関係の外部でホストされているドキュメントへのリンクを作成できます。
たとえば、kotlinx.serialization の型を使用している場合、デフォルトでは未解決であるかのようにドキュメント内でクリックできません。しかし、kotlinx.serialization のAPIリファレンスドキュメントはDokkaによって構築され、kotlinlang.orgで公開されているため、その外部ドキュメントリンクを設定できます。これにより、Dokkaはそのライブラリの型に対するリンクを生成できるようになり、正常に解決されてクリック可能になります。
外部ドキュメントリンクはすべてのソースセットに対して一度にまとめて設定することも、個別に設定することもできます。
{
"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による自動解決に依存する代わりの手段となります。
パッケージリストには、モジュール名やパッケージ名など、ドキュメントおよびプロジェクト自体に関する情報が含まれています。
ネットワーク呼び出しを回避するために、ローカルにキャッシュされたファイルを指定することもできます。
完全な設定例
以下は、指定可能なすべての設定オプションを同時に適用した例です。
{
"moduleName": "Dokka Example",
"moduleVersion": null,
"outputDir": "./build/dokka/html",
"failOnWarning": false,
"suppressObviousFunctions": true,
"suppressInheritedMembers": false,
"offlineMode": false,
"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.4.21.jar",
"libs/kotlin-stdlib-common-2.4.21.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.2.0.jar",
"./kotlinx-html-jvm-0.8.0.jar",
"./analysis-kotlin-symbols-2.2.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"
]
}