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

Формат файла

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

Файл не обязательно должен содержать документацию и для подпроекта, и для пакетов. Можно создавать файлы, содержащие документацию только для пакетов или только для подпроекта. Можно даже создать отдельный файл Markdown для каждого подпроекта или пакета.

Используя синтаксис Markdown, можно добавить:

• Заголовки до 6-го уровня

• Выделение жирным или курсивом

• Ссылки

• Встроенный код

• Блоки кода

• Цитаты

Вот пример файла, содержащего документацию и для подпроекта, и для пакета:

# Module kotlin-demo

This content appears under your subproject 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, необходимо использовать соответствующий параметр includes для Gradle, Maven или CLI: