Dokkatoo Gradle Plugin/dev.adamko.dokkatoo.dokka.parameters/DokkaModuleDescriptionKxs

DokkaModuleDescriptionKxs

@Serializable

data class DokkaModuleDescriptionKxs(val name: String, val modulePath: String, val moduleOutputDirName: String = "module", val moduleIncludesDirName: String = "includes")(source)

Any subproject can be merged into a single Dokka Publication. To do this, first it must create a Dokka Module. A DokkaModuleDescriptionKxs describes a config file for the Dokka Module that describes its content. This config file will be used by any aggregating project to produce a Dokka Publication with multiple modules.

Note: this class implements java.io.Serializable because it is used as a Gradle Property, and Gradle must be able to fingerprint property values classes using Java Serialization.

All other configuration data classes also implement java.io.Serializable via their parent interfaces.

Constructors

DokkaModuleDescriptionKxs

constructor(name: String, modulePath: String, moduleOutputDirName: String = "module", moduleIncludesDirName: String = "includes")

Properties

moduleIncludesDirName

val moduleIncludesDirName: String

name of the sibling directory that contains the module includes

moduleOutputDirName

val moduleOutputDirName: String

name of the sibling directory that contains the module output

modulePath

val modulePath: String

name

val name: String