Configuration Reference
Properties
Property | Type | Default | Description |
|---|---|---|---|
|
|
| Master switch — applies and configures Dokka when |
|
| (not set) | The module name shown in the generated documentation |
|
| (not set) | Footer message rendered on every page of the HTML output |
|
| (Dokka default: | Output path relative to the Gradle |
All properties are optional except enabled. When a property is not set, Kreate skips that part of the Dokka configuration and leaves the Dokka default in place.
moduleName
Sets DokkaExtension.moduleName. This value appears as the top-level title in the generated HTML site and in the module list when multiple modules are aggregated.
copyright
Sets the footerMessage of Dokka's HTML plugin parameters. The string is rendered as plain HTML in the footer of every generated page, so HTML tags are supported.
If copyright is not present, the footer configuration block is skipped entirely and Dokka's default (empty footer) is used.
outputDirectory
Redirects the html Dokka publication output to a custom subdirectory inside build/. The path is relative to the build directory.
The HTML site is then written to build/docs/api/ instead of the default build/dokka/html/.