Dokkatoo Gradle Plugin/dev.adamko.dokkatoo.dokka.parameters/DokkaSourceSetSpec/includes

includes

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val includes: ConfigurableFileCollection(source)

List of Markdown files that contain module and package documentation.

Contents of specified files will be parsed and embedded into documentation as module and package descriptions.

Example of such a file:

# Module kotlin-demo

The module shows the Dokka usage.

# Package org.jetbrains.kotlin.demo

Contains assorted useful stuff.

## Level 2 heading

Text after this heading is also part of documentation for `org.jetbrains.kotlin.demo`

# Package org.jetbrains.kotlin.demo2

Useful stuff in another package.