DokkaConfigurationImpl

data class DokkaConfigurationImpl(val moduleName: String = DokkaDefaults.moduleName, val moduleVersion: String? = DokkaDefaults.moduleVersion, val outputDir: File = DokkaDefaults.outputDir, val cacheRoot: File? = DokkaDefaults.cacheRoot, val offlineMode: Boolean = DokkaDefaults.offlineMode, val sourceSets: List<DokkaSourceSetImpl> = emptyList(), val pluginsClasspath: List<File> = emptyList(), val pluginsConfiguration: List<PluginConfigurationImpl> = DokkaDefaults.pluginsConfiguration, val modules: List<DokkaModuleDescriptionImpl> = emptyList(), val failOnWarning: Boolean = DokkaDefaults.failOnWarning, val delayTemplateSubstitution: Boolean = false, val suppressObviousFunctions: Boolean = DokkaDefaults.suppressObviousFunctions, val includes: Set<File> = emptySet(), val suppressInheritedMembers: Boolean = DokkaDefaults.suppressInheritedMembers, val finalizeCoroutines: Boolean = true) : DokkaConfiguration

Constructors

Link copied to clipboard
constructor(moduleName: String = DokkaDefaults.moduleName, moduleVersion: String? = DokkaDefaults.moduleVersion, outputDir: File = DokkaDefaults.outputDir, cacheRoot: File? = DokkaDefaults.cacheRoot, offlineMode: Boolean = DokkaDefaults.offlineMode, sourceSets: List<DokkaSourceSetImpl> = emptyList(), pluginsClasspath: List<File> = emptyList(), pluginsConfiguration: List<PluginConfigurationImpl> = DokkaDefaults.pluginsConfiguration, modules: List<DokkaModuleDescriptionImpl> = emptyList(), failOnWarning: Boolean = DokkaDefaults.failOnWarning, delayTemplateSubstitution: Boolean = false, suppressObviousFunctions: Boolean = DokkaDefaults.suppressObviousFunctions, includes: Set<File> = emptySet(), suppressInheritedMembers: Boolean = DokkaDefaults.suppressInheritedMembers, finalizeCoroutines: Boolean = true)

Properties

Link copied to clipboard
open override val cacheRoot: File?
Link copied to clipboard
open override val delayTemplateSubstitution: Boolean = false
Link copied to clipboard
open override val failOnWarning: Boolean
Link copied to clipboard
open override val finalizeCoroutines: Boolean = true

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

Link copied to clipboard
open override val includes: Set<File>
Link copied to clipboard
open override val moduleName: String
Link copied to clipboard
Link copied to clipboard
open override val moduleVersion: String?
Link copied to clipboard
open override val offlineMode: Boolean
Link copied to clipboard
open override val outputDir: File
Link copied to clipboard
open override val pluginsClasspath: List<File>
Link copied to clipboard
Link copied to clipboard
open override val sourceSets: List<DokkaSourceSetImpl>
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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