模块文档

Documentation for a module as a whole, as well as packages in that module, can be provided as separate Markdown files.

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:

  1. # Module kotlin-demo
  3. This content appears under your module name.
  5. # Package org.jetbrains.kotlin.demo
  7. This content appears under your package name in the packages list.
  8. It also appears under the first-level heading on your package's page.
  10. ## Level 2 heading for package org.jetbrains.kotlin.demo
  12. Content after this heading is also part of documentation for `org.jetbrains.kotlin.demo`
  14. # Package org.jetbrains.kotlin.demo2
  16. This content appears under your package name in the packages list.
  17. It also appears under the first-level heading on your package's page.
  19. ## Level 2 heading for package org.jetbrains.kotlin.demo2
  21. Content after this heading is also part of documentation for `org.jetbrains.kotlin.demo2`

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:

【Gradle】

Use the includes option in Source set configuration.

【Maven】

Use the includes option in General configuration.

【CLI】

If you are using command line configuration, use the includes option in Source set options.

If you are using JSON configuration, use the includes option in General configuration.