gradle-plugin/org.jetbrains.dokka.gradle/DokkaTask

DokkaTask

@CacheableTask

abstract class DokkaTask : AbstractDokkaLeafTask

Constructors

DokkaTask

fun DokkaTask()

Functions

appendParallelSafeAction

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

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

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

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

open override fun doFirst(p0: String, p1: 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

getEnabled

open override fun getEnabled(): 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

getImpliesSubProjects

open override fun getImpliesSubProjects(): Boolean

getInputs

open override fun getInputs(): TaskInputsInternal

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(): Spec<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>

getRequiredServices

open override fun getRequiredServices(): MutableSet<Provider<out BuildService<*>>>

getServices

@Internal

open fun getServices(): ServiceRegistry

getSharedResources

open override fun getSharedResources(): MutableList<ResourceLock>

getShouldRunAfter

open override fun getShouldRunAfter(): TaskDependency

getStandardOutputCapture

open override fun getStandardOutputCapture(): StandardOutputCapture

getState

open override fun getState(): TaskStateInternal

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>

getTimeout

open override fun getTimeout(): Property<Duration>

hasProperty

open override fun hasProperty(p0: String): Boolean

hasTaskActions

open override fun hasTaskActions(): Boolean

isEnabled

@Internal

open fun isEnabled(): Boolean

isHasCustomActions

open override fun isHasCustomActions(): Boolean

mustRunAfter

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

onlyIf

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

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

pluginConfiguration

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

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)

setEnabled

open override fun setEnabled(p0: Boolean)

setFinalizedBy

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

setGroup

open override fun setGroup(p0: String?)

setImpliesSubProjects

open override fun setImpliesSubProjects(p0: Boolean)

setMustRunAfter

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

setOnlyIf

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

open override fun setOnlyIf(p0: 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<*>>)

Properties

cacheRoot

@Optional

@InputDirectory

@PathSensitive(value = PathSensitivity.RELATIVE)

val cacheRoot: Property<File?>

dokkaSourceSets

@get:Internal

val dokkaSourceSets: NamedDomainObjectContainer<GradleDokkaSourceSetBuilder>

failOnWarning

@Input

val failOnWarning: Property<Boolean>

moduleName

@Input

val moduleName: Property<String>

moduleVersion

@Input

val moduleVersion: Property<String>

offlineMode

@Input

val offlineMode: Property<Boolean>

outputDirectory

@OutputDirectory

val outputDirectory: Property<File>

plugins

@Classpath

val plugins: Configuration

pluginsConfiguration

@Input

val pluginsConfiguration: ListProperty<in DokkaConfiguration.PluginConfiguration>

pluginsMapConfiguration

@Input

val pluginsMapConfiguration: MapProperty<String, String>

Used to keep compatibility with gradle using Kotlin lower than 1.3.50

runtime

@Classpath

val runtime: Configuration

suppressInheritedMembers

@Input

val suppressInheritedMembers: Property<Boolean>

suppressObviousFunctions

@Input

val suppressObviousFunctions: Property<Boolean>

valuableSubprojectsDokkaSourceSets

@get:Internal

val valuableSubprojectsDokkaSourceSets: List<NamedDomainObjectContainer<GradleDokkaSourceSetBuilder>>

valuableSubprojectsNames

@get:Internal

var valuableSubprojectsNames: Set<String>