Module documentation

File format

Inside the Markdown file, the documentation for the module as a whole and for individual packages is introduced by the corresponding first-level headings. The text of the heading must be Module <module name> for a module, and Package <package qualified name> for a package.

The file doesn't have to contain both module and package documentation. You can have files that contain only package or module documentation. You can even have a Markdown file per module or package.

Using Markdown syntax, you can add:

• Headings up to level 6

• Emphasis with bold or italic formatting

• Links

• Inline code

• Code blocks

• Blockquotes

Here's an example file containing both module and package documentation:

To explore an example project with Gradle, see Dokka gradle example.

Pass files to Dokka

To pass these files to Dokka, you need to use the relevant includes option for Gradle, Maven, or CLI: