AbstractDokkaTask

abstract class AbstractDokkaTask : DefaultTask

Functions

appendParallelSafeAction
Link copied to clipboard
open override fun appendParallelSafeAction(p0: Action<in Task>)
compareTo
Link copied to clipboard
open operator override fun compareTo(other: Task): Int
configure
Link copied to clipboard
open override fun configure(p0: Closure<Any>): Task
dependsOn
Link copied to clipboard
open override fun dependsOn(vararg p0: Any): Task
doFirst
Link copied to clipboard
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
Link copied to clipboard
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
finalizedBy
Link copied to clipboard
open override fun finalizedBy(vararg p0: Any): Task
getActions
Link copied to clipboard
open override fun getActions(): MutableList<Action<in Task>>
getAnt
Link copied to clipboard
open override fun getAnt(): AntBuilder
getAsDynamicObject
Link copied to clipboard
@Internal()
open override fun getAsDynamicObject(): DynamicObject
getConvention
Link copied to clipboard
@Internal()
open override fun getConvention(): Convention
getDependsOn
Link copied to clipboard
open override fun getDependsOn(): MutableSet<Any>
getDescription
Link copied to clipboard
open override fun getDescription(): String?
getDestroyables
Link copied to clipboard
open override fun getDestroyables(): TaskDestroyables
getDidWork
Link copied to clipboard
open override fun getDidWork(): Boolean
getEnabled
Link copied to clipboard
open override fun getEnabled(): Boolean
getExtensions
Link copied to clipboard
open override fun getExtensions(): ExtensionContainer
getFinalizedBy
Link copied to clipboard
open override fun getFinalizedBy(): TaskDependency
getGroup
Link copied to clipboard
open override fun getGroup(): String?
getIdentityPath
Link copied to clipboard
open override fun getIdentityPath(): Path
getImpliesSubProjects
Link copied to clipboard
open override fun getImpliesSubProjects(): Boolean
getInputs
Link copied to clipboard
open override fun getInputs(): TaskInputsInternal
getLocalState
Link copied to clipboard
open override fun getLocalState(): TaskLocalState
getLogger
Link copied to clipboard
open override fun getLogger(): Logger
getLogging
Link copied to clipboard
open override fun getLogging(): LoggingManager
getMustRunAfter
Link copied to clipboard
open override fun getMustRunAfter(): TaskDependency
getName
Link copied to clipboard
open override fun getName(): String
getOnlyIf
Link copied to clipboard
open override fun getOnlyIf(): Spec<in TaskInternal>
getOutputs
Link copied to clipboard
open override fun getOutputs(): TaskOutputsInternal
getPath
Link copied to clipboard
open override fun getPath(): String
getProject
Link copied to clipboard
open override fun getProject(): Project
getRequiredServices
Link copied to clipboard
open override fun getRequiredServices(): MutableSet<Provider<out BuildService<*>>>
getServices
Link copied to clipboard
@Internal()
open fun getServices(): ServiceRegistry
getSharedResources
Link copied to clipboard
open override fun getSharedResources(): MutableList<ResourceLock>
getShouldRunAfter
Link copied to clipboard
open override fun getShouldRunAfter(): TaskDependency
getStandardOutputCapture
Link copied to clipboard
open override fun getStandardOutputCapture(): StandardOutputCapture
getState
Link copied to clipboard
open override fun getState(): TaskStateInternal
getTaskActions
Link copied to clipboard
open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction>
getTaskDependencies
Link copied to clipboard
open override fun getTaskDependencies(): TaskDependencyInternal
getTaskIdentity
Link copied to clipboard
open override fun getTaskIdentity(): TaskIdentity<*>
getTemporaryDir
Link copied to clipboard
open override fun getTemporaryDir(): File
getTemporaryDirFactory
Link copied to clipboard
open override fun getTemporaryDirFactory(): Factory<File>
getTimeout
Link copied to clipboard
open override fun getTimeout(): Property<Duration>
hasProperty
Link copied to clipboard
open override fun hasProperty(p0: String): Boolean
hasTaskActions
Link copied to clipboard
open override fun hasTaskActions(): Boolean
isEnabled
Link copied to clipboard
@Internal()
open fun isEnabled(): Boolean
isHasCustomActions
Link copied to clipboard
open override fun isHasCustomActions(): Boolean
mustRunAfter
Link copied to clipboard
open override fun mustRunAfter(vararg p0: Any): Task
onlyIf
Link copied to clipboard
open override fun onlyIf(p0: Closure<Any>)
open override fun onlyIf(p0: Spec<in Task>)
pluginConfiguration
Link copied to clipboard
inline fun <P : DokkaPlugin, T : ConfigurableBlock> pluginConfiguration(block: T.() -> Unit)
prependParallelSafeAction
Link copied to clipboard
open override fun prependParallelSafeAction(p0: Action<in Task>)
property
Link copied to clipboard
open override fun property(p0: String): Any?
setActions
Link copied to clipboard
open override fun setActions(p0: MutableList<Action<in Task>>)
setDependsOn
Link copied to clipboard
open override fun setDependsOn(p0: MutableIterable<*>)
setDescription
Link copied to clipboard
open override fun setDescription(p0: String?)
setDidWork
Link copied to clipboard
open override fun setDidWork(p0: Boolean)
setEnabled
Link copied to clipboard
open override fun setEnabled(p0: Boolean)
setFinalizedBy
Link copied to clipboard
open override fun setFinalizedBy(p0: MutableIterable<*>)
setGroup
Link copied to clipboard
open override fun setGroup(p0: String?)
setImpliesSubProjects
Link copied to clipboard
open override fun setImpliesSubProjects(p0: Boolean)
setMustRunAfter
Link copied to clipboard
open override fun setMustRunAfter(p0: MutableIterable<*>)
setOnlyIf
Link copied to clipboard
open override fun setOnlyIf(p0: Closure<Any>)
open override fun setOnlyIf(p0: Spec<in Task>)
setProperty
Link copied to clipboard
open override fun setProperty(p0: String, p1: Any)
setShouldRunAfter
Link copied to clipboard
open override fun setShouldRunAfter(p0: MutableIterable<*>)
shouldRunAfter
Link copied to clipboard
open override fun shouldRunAfter(vararg p0: Any): TaskDependency
usesService
Link copied to clipboard
open override fun usesService(p0: Provider<out BuildService<*>>)

Properties

cacheRoot
Link copied to clipboard
@Optional()
@InputDirectory()
@PathSensitive(value = PathSensitivity.RELATIVE)
val cacheRoot: Property<File?>
failOnWarning
Link copied to clipboard
@Input()
val failOnWarning: Property<Boolean>
moduleName
Link copied to clipboard
@Input()
val moduleName: Property<String>
moduleVersion
Link copied to clipboard
@Input()
val moduleVersion: Property<String>
offlineMode
Link copied to clipboard
@Input()
val offlineMode: Property<Boolean>
outputDirectory
Link copied to clipboard
@OutputDirectory()
val outputDirectory: Property<File>
plugins
Link copied to clipboard
@Classpath()
val plugins: Configuration
pluginsConfiguration
Link copied to clipboard
@Input()
val pluginsConfiguration: ListProperty<in DokkaConfiguration.PluginConfiguration>
pluginsMapConfiguration
Link copied to clipboard
@Input()
val pluginsMapConfiguration: MapProperty<String, String>
Used to keep compatibility with gradle using Kotlin lower than 1.3.
runtime
Link copied to clipboard
@Classpath()
val runtime: Configuration
suppressInheritedMembers
Link copied to clipboard
@Input()
val suppressInheritedMembers: Property<Boolean>
suppressObviousFunctions
Link copied to clipboard
@Input()
val suppressObviousFunctions: Property<Boolean>

Inheritors

AbstractDokkaLeafTask
Link copied to clipboard
AbstractDokkaParentTask
Link copied to clipboard

Extensions

gradleDokkaSourceSetBuilderFactory
Link copied to clipboard
fun AbstractDokkaTask.gradleDokkaSourceSetBuilderFactory(): NamedDomainObjectFactory<GradleDokkaSourceSetBuilder>