core/org.jetbrains.dokka/DokkaConfiguration

DokkaConfiguration

interface DokkaConfiguration : Serializable

Inheritors

DokkaConfigurationImpl

Types

DokkaModuleDescription

interface DokkaModuleDescription : Serializable

interface DokkaSourceSet : Serializable

ExternalDocumentationLink

interface ExternalDocumentationLink : Serializable

interface PackageOptions : Serializable

PluginConfiguration

interface PluginConfiguration : Serializable

SerializationFormat

enum SerializationFormat : Enum<DokkaConfiguration.SerializationFormat> , Serializable

SourceLinkDefinition

interface SourceLinkDefinition : Serializable

enum Visibility : Enum<DokkaConfiguration.Visibility>

Properties

abstract val cacheRoot: File?

delayTemplateSubstitution

abstract val delayTemplateSubstitution: Boolean

abstract val failOnWarning: Boolean

finalizeCoroutines

abstract val finalizeCoroutines: Boolean

Whether coroutines dispatchers should be shutdown after generating documentation via DokkaGenerator.generate.

abstract val includes: Set<File>

abstract val moduleName: String

abstract val modules: List<DokkaConfiguration.DokkaModuleDescription>

abstract val moduleVersion: String?

abstract val offlineMode: Boolean

abstract val outputDir: File

pluginsClasspath

abstract val pluginsClasspath: List<File>

pluginsConfiguration

abstract val pluginsConfiguration: List<DokkaConfiguration.PluginConfiguration>

abstract val sourceSets: List<DokkaConfiguration.DokkaSourceSet>

suppressInheritedMembers

abstract val suppressInheritedMembers: Boolean

suppressObviousFunctions

abstract val suppressObviousFunctions: Boolean

Functions

fun DokkaConfiguration.apply(globals: GlobalDokkaConfiguration): DokkaConfiguration

toCompactJsonString

fun DokkaConfiguration.toCompactJsonString(): String

Serializes DokkaConfiguration as a machine-readable and compact JSON string.

fun DokkaConfiguration.~~toJsonString~~(): String

toPrettyJsonString

fun DokkaConfiguration.toPrettyJsonString(): String

Serializes DokkaConfiguration as a human-readable (pretty printed) JSON string.