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

DokkaPluginParametersBuilder

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

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

This type of builder is necessary to respect Gradle incremental build annotations.

Parameters

pluginFqn

The fully-qualified name of a Dokka Plugin. For example, the Dokka Base plugin's FQN is org.jetbrains.dokka.base.DokkaBase

Constructors

DokkaPluginParametersBuilder

@Inject

@DokkatooInternalApi

constructor(name: String, pluginFqn: String, objects: ObjectFactory)

Types

object Companion

Properties

@get:Input

open override val pluginFqn: String

Functions

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

open override fun getName(): String

open override fun jsonEncode(): String

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

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>)