pluginConfiguration

inline fun <P : DokkaPlugin, T : ConfigurableBlock> pluginConfiguration(block: T.() -> Unit)

Type-safe configuration for a Dokka plugin.

Note: this is available in Kotlin DSL only, if Dokka Gradle plugin was applied through plugins block and the configured plugin can be found on classpath, which may require adding a classpath dependency to buildscript block in case of external plugins. Some Dokka plugins, such as org.jetbrains.dokka.base.DokkaBase, are on classpath by default.

Example:

import org.jetbrains.dokka.base.DokkaBase
import org.jetbrains.dokka.base.DokkaBaseConfiguration

tasks.dokkaHtml {
pluginConfiguration<DokkaBase, DokkaBaseConfiguration> {
footerMessage = "Test"
}
}

Parameters

P

Plugin class that extends DokkaPlugin

T

Plugin configuration class that extends ConfigurableBlock