DokkaConfiguration

Types

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Properties

Link copied to clipboard
abstract val cacheRoot: File?
Link copied to clipboard
Link copied to clipboard
abstract val failOnWarning: Boolean
Link copied to clipboard

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

Link copied to clipboard
abstract val includes: Set<File>
Link copied to clipboard
abstract val moduleName: String
Link copied to clipboard
Link copied to clipboard
abstract val moduleVersion: String?
Link copied to clipboard
abstract val offlineMode: Boolean
Link copied to clipboard
abstract val outputDir: File
Link copied to clipboard
abstract val pluginsClasspath: List<File>
Link copied to clipboard
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.