core/org.jetbrains.dokka/DokkaConfiguration

DokkaConfiguration

interface DokkaConfiguration : Serializable

Types

DokkaModuleDescription

interface DokkaModuleDescription : Serializable

DokkaSourceSet

interface DokkaSourceSet : Serializable

ExternalDocumentationLink

interface ExternalDocumentationLink : Serializable

PackageOptions

interface PackageOptions : Serializable

PluginConfiguration

interface PluginConfiguration : Serializable

SerializationFormat

enum SerializationFormat : Enum<DokkaConfiguration.SerializationFormat> , Serializable

SourceLinkDefinition

interface SourceLinkDefinition : Serializable

Functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Properties

cacheRoot

abstract val cacheRoot: File?

failOnWarning

abstract val failOnWarning: Boolean

moduleName

abstract val moduleName: String

modules

abstract val modules: List<DokkaConfiguration.DokkaModuleDescription>

moduleVersion

abstract val moduleVersion: String?

offlineMode

abstract val offlineMode: Boolean

outputDir

abstract val outputDir: File

pluginsClasspath

abstract val pluginsClasspath: List<File>

pluginsConfiguration

abstract val pluginsConfiguration: List<DokkaConfiguration.PluginConfiguration>

sourceSets

abstract val sourceSets: List<DokkaConfiguration.DokkaSourceSet>

Inheritors

DokkaConfigurationImpl

Extensions

toJsonString

fun DokkaConfiguration.toJsonString(): String