モジュールドキュメント

モジュール全体のドキュメント、およびそのモジュール内のパッケージのドキュメントは、個別のMarkdownファイルとして提供できます。

ファイル形式

Markdownファイル内では、モジュール全体および個々のパッケージのドキュメントは、対応する第一レベルの見出しによって導入されます。見出しのテキストは、モジュールの場合Module <module name>、パッケージの場合Package <package qualified name>である必要があります。

ファイルは、モジュールとパッケージの両方のドキュメントを含む必要はありません。パッケージのみ、またはモジュールのみのドキュメントを含むファイルを持つことができます。モジュールまたはパッケージごとにMarkdownファイルを持つことさえできます。

Markdown構文を使用して、以下を追加できます。

• レベル6までの見出し
• 太字またはイタリックによる強調表示
• リンク
• インラインコード
• コードブロック
• 引用ブロック

モジュールとパッケージの両方のドキュメントを含むファイルの例を以下に示します。

# 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 exampleを参照してください。

ファイルをDokkaに渡す

これらのファイルをDokkaに渡すには、Gradle、Maven、またはCLIの関連するincludesオプションを使用する必要があります。