Configuration for Dokka plugins. This property is not expected to be used directly - if possible, use pluginConfiguration blocks (preferred) or pluginsMapConfiguration instead.

pluginsMapConfiguration

@Input

val pluginsMapConfiguration: MapProperty<String, String>

JSON configuration of Dokka plugins.

requiredServices

val requiredServices: MutableSet<Provider<out BuildService<*>>>

runtime

@Classpath

val runtime: Configuration

state

val state: TaskStateInternal

suppressInheritedMembers

@Input

val suppressInheritedMembers: Property<Boolean>

Whether to suppress inherited members that aren't explicitly overridden in a given class.

suppressObviousFunctions

@Input

val suppressObviousFunctions: Property<Boolean>

Whether to suppress obvious functions.

timeout

val timeout: Property<Duration>

Functions

appendParallelSafeAction

open override fun appendParallelSafeAction(p0: Action<in Task>)

buildJsonConfiguration

fun AbstractDokkaTask.buildJsonConfiguration(prettyPrint: Boolean = true): String

Serializes DokkaConfiguration of this AbstractDokkaTask as json

compareTo

open operator override fun compareTo(other: Task): Int

configure

open override fun configure(p0: Closure<Any>): Task

dependsOn

open override fun dependsOn(vararg p0: Any): Task

doFirst

open override fun doFirst(p0: String, p1: Action<in Task>): Task

override fun doFirst(action: Closure<*>): Task

override fun doFirst(action: Action<in Task>): Task

doLast

open override fun doLast(p0: Closure<Any>): Task

open override fun doLast(p0: Action<in Task>): Task

open override fun doLast(p0: String, p1: Action<in Task>): Task

doNotTrackState

open override fun doNotTrackState(p0: String)

finalizedBy

open override fun finalizedBy(vararg p0: Any): Task

getActions

open override fun getActions(): MutableList<Action<in Task>>

getAnt

open override fun getAnt(): AntBuilder

getAsDynamicObject

@Internal

open override fun getAsDynamicObject(): DynamicObject

getConvention

@Internal

open override fun ~~getConvention~~(): Convention

getDependsOn

open override fun getDependsOn(): MutableSet<Any>

getDescription

open override fun getDescription(): String?

getDestroyables

open override fun getDestroyables(): TaskDestroyables

getDidWork

open override fun getDidWork(): Boolean

getExtensions

open override fun getExtensions(): ExtensionContainer

getFinalizedBy

open override fun getFinalizedBy(): TaskDependency

getGroup

open override fun getGroup(): String?

getIdentityPath

open override fun getIdentityPath(): Path

getInputs

open override fun getInputs(): TaskInputsInternal

getLifecycleDependencies

@Internal

open override fun getLifecycleDependencies(): TaskDependencyInternal

getLocalState

open override fun getLocalState(): TaskLocalState

getLogger

open override fun getLogger(): Logger

getLogging

open override fun getLogging(): LoggingManager

getMustRunAfter

open override fun getMustRunAfter(): TaskDependency

getName

open override fun getName(): String

getOnlyIf

open override fun getOnlyIf(): DescribingAndSpec<in TaskInternal>

getOutputs

open override fun getOutputs(): TaskOutputsInternal

getPath

open override fun getPath(): String

getProject

open override fun getProject(): Project

getReasonNotToTrackState

open override fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open override fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getSharedResources

open override fun getSharedResources(): MutableList<ResourceLock>

getShouldRunAfter

open override fun getShouldRunAfter(): TaskDependency

getStandardOutputCapture

open override fun getStandardOutputCapture(): StandardOutputCapture

getTaskActions

open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction>

getTaskDependencies

open override fun getTaskDependencies(): TaskDependencyInternal

getTaskIdentity

open override fun getTaskIdentity(): TaskIdentity<*>

getTemporaryDir

open override fun getTemporaryDir(): File

getTemporaryDirFactory

open override fun getTemporaryDirFactory(): Factory<File>

gradleDokkaSourceSetBuilderFactory

fun AbstractDokkaTask.gradleDokkaSourceSetBuilderFactory(): NamedDomainObjectFactory<GradleDokkaSourceSetBuilder>

hasProperty

open override fun hasProperty(p0: String): Boolean

hasTaskActions

open override fun hasTaskActions(): Boolean

isCompatibleWithConfigurationCache

open override fun isCompatibleWithConfigurationCache(): Boolean

mustRunAfter

open override fun mustRunAfter(vararg p0: Any): Task

notCompatibleWithConfigurationCache

open override fun notCompatibleWithConfigurationCache(p0: String)

onlyIf

open override fun onlyIf(p0: Closure<Any>)

open override fun onlyIf(p0: Spec<in Task>)

open override fun onlyIf(p0: String, p1: Spec<in Task>)

pluginConfiguration

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

Type-safe configuration for a Dokka plugin.

prependParallelSafeAction

open override fun prependParallelSafeAction(p0: Action<in Task>)

property

open override fun property(p0: String): Any?

setActions

open override fun setActions(p0: MutableList<Action<in Task>>)

setDependsOn

open override fun setDependsOn(p0: MutableIterable<*>)

setDescription

open override fun setDescription(p0: String?)

setDidWork

open override fun setDidWork(p0: Boolean)

setFinalizedBy

open override fun setFinalizedBy(p0: MutableIterable<*>)

setGroup

open override fun setGroup(p0: String?)

setMustRunAfter

open override fun setMustRunAfter(p0: MutableIterable<*>)

setOnlyIf

open override fun setOnlyIf(p0: Closure<Any>)

open override fun setOnlyIf(p0: Spec<in Task>)

open override fun setOnlyIf(p0: String, p1: Spec<in Task>)

setProperty

open override fun setProperty(p0: String, p1: Any)

setShouldRunAfter

open override fun setShouldRunAfter(p0: MutableIterable<*>)

shouldRunAfter

open override fun shouldRunAfter(vararg p0: Any): TaskDependency

usesService

open override fun usesService(p0: Provider<out BuildService<*>>)