モジュール ドキュメント
モジュール全体、およびそのモジュール内のパッケージに関するドキュメントは、個別のMarkdownファイルとして提供できます。
ファイル形式
Markdownファイル内では、モジュール全体および個々のパッケージに関するドキュメントは、対応する第1レベルの見出しによって導入されます。見出しのテキストは、モジュールの場合はModule <module name>、パッケージの場合はPackage <package qualified name>である必要があります。
ファイルには、モジュールとパッケージの両方のドキュメントを含める必要はありません。パッケージまたはモジュールのみを含むファイルを持つことができます。モジュールまたはパッケージごとにMarkdownファイルを持つことさえ可能です。
Markdown構文を使用して、以下を追加できます。
- レベル6までの見出し
- 太字または斜体による強調
- リンク
- インラインコード
- コードブロック
- 引用ブロック
モジュールとパッケージの両方のドキュメントを含むファイルの例を次に示します。
text
# Module kotlin-demo
This content appears under your module name.
# Package org.jetbrains.kotlin.demo
This content appears under your package name in the packages list.
It also appears under the first-level heading on your package's page.
## Level 2 heading for package org.jetbrains.kotlin.demo
Content after this heading is also part of documentation for `org.jetbrains.kotlin.demo`
# Package org.jetbrains.kotlin.demo2
This content appears under your package name in the packages list.
It also appears under the first-level heading on your package's page.
## Level 2 heading for package org.jetbrains.kotlin.demo2
Content after this heading is also part of documentation for `org.jetbrains.kotlin.demo2`Gradleを使用したサンプルプロジェクトについては、Dokka Gradleの例を参照してください。
ファイルをDokkaに渡す
これらのファイルをDokkaに渡すには、Gradle、Maven、またはCLIの関連するincludesオプションを使用する必要があります。