Документация модуля

Формат файла

Внутри файла Markdown документация для модуля в целом и для отдельных пакетов вводится соответствующими заголовками первого уровня. Текст заголовка должен быть Модуль <module name> для модуля и Пакет <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.

Передача файлов в Dokka

Чтобы передать эти файлы в Dokka, необходимо использовать соответствующий параметр включений для Gradle, Maven или командной строки: