Dokkatoo Gradle Plugin/dev.adamko.dokkatoo.dokka.plugins

Package-level declarations

Parameters for configuring the behaviour of Dokka Plugins.

Types

abstract class DokkaHtmlPluginParameters @DokkatooInternalApi @Inject constructor(name: String) : DokkaPluginParametersBaseSpec

Configuration for Dokka's base HTML format

DokkaPluginParametersBaseSpec

abstract class DokkaPluginParametersBaseSpec @DokkatooInternalApi @Inject constructor(name: String, val pluginFqn: String) : Serializable, Named

Base class for defining Dokka Plugin configuration.

DokkaPluginParametersBuilder

abstract class DokkaPluginParametersBuilder @Inject @DokkatooInternalApi constructor(name: String, val pluginFqn: String, objects: ObjectFactory) : DokkaPluginParametersBaseSpec

Dynamically create some configuration to control the behaviour of a Dokka Plugin.

DokkaVersioningPluginParameters

abstract class DokkaVersioningPluginParameters @DokkatooInternalApi @Inject constructor(name: String) : DokkaPluginParametersBaseSpec

Configuration for Dokka's Versioning plugin.

PluginConfigValue

sealed interface PluginConfigValue

Functions

add

fun PluginConfigValue.Values.add(value: Boolean)

fun PluginConfigValue.Values.add(value: Number)

fun PluginConfigValue.Values.add(value: String)

@JvmName(name = "addBoolean")

fun PluginConfigValue.Values.add(value: Provider<Boolean>)

@JvmName(name = "addNumber")

fun PluginConfigValue.Values.add(value: Provider<Number>)

@JvmName(name = "addString")

fun PluginConfigValue.Values.add(value: Provider<String>)

files

fun DokkaPluginParametersBuilder.files(propertyName: String, filesConfig: ConfigurableFileCollection.() -> Unit)

PluginConfigValue

fun PluginConfigValue(value: Boolean): PluginConfigValue.BooleanValue

fun PluginConfigValue(value: Number): PluginConfigValue.NumberValue

fun PluginConfigValue(value: String): PluginConfigValue.StringValue

@JvmName(name = "PluginConfigBooleanValue")

fun PluginConfigValue(value: Provider<Boolean>): Provider<PluginConfigValue.BooleanValue>

@JvmName(name = "PluginConfigNumberValue")

fun PluginConfigValue(value: Provider<Number>): Provider<PluginConfigValue.NumberValue>

@JvmName(name = "PluginConfigStringValue")

fun PluginConfigValue(value: Provider<String>): Provider<PluginConfigValue.StringValue>

pluginParameters

fun DokkaPluginParametersContainer.pluginParameters(pluginFqn: String, configure: DokkaPluginParametersBuilder.() -> Unit)

Dynamically create some configuration to control the behaviour of a Dokka Plugin.

properties

fun DokkaPluginParametersBuilder.properties(propertyName: String, build: PluginConfigValue.Values.() -> Unit)

property

fun DokkaPluginParametersBuilder.property(propertyName: String, value: Boolean)

fun DokkaPluginParametersBuilder.property(propertyName: String, value: Number)

fun DokkaPluginParametersBuilder.property(propertyName: String, value: String)

@JvmName(name = "booleanProperty")

fun DokkaPluginParametersBuilder.property(propertyName: String, provider: Provider<Boolean>)

@JvmName(name = "numberProperty")

fun DokkaPluginParametersBuilder.property(propertyName: String, provider: Provider<Number>)

@JvmName(name = "stringProperty")

fun DokkaPluginParametersBuilder.property(propertyName: String, provider: Provider<String>)