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

AbstractDokkaTask

@DisableCachingByDefault(because = "Abstract super-class, not to be instantiated directly")

abstract class AbstractDokkaTask : DefaultTask

Constructors

AbstractDokkaTask

fun AbstractDokkaTask()

Functions

appendParallelSafeAction

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

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

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

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

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

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)

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

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

open override fun getAnt(): AntBuilder

getAsDynamicObject

@Internal

open override fun getAsDynamicObject(): DynamicObject

@Internal

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

open override fun getDependsOn(): MutableSet<Any>

open override fun getDescription(): String?

getDestroyables

open override fun getDestroyables(): TaskDestroyables

open override fun getDidWork(): Boolean

open override fun getExtensions(): ExtensionContainer

open override fun getFinalizedBy(): TaskDependency

open override fun getGroup(): String?

getIdentityPath

open override fun getIdentityPath(): Path

open override fun getInputs(): TaskInputsInternal

getLifecycleDependencies

@Internal

open override fun getLifecycleDependencies(): TaskDependencyInternal

open override fun getLocalState(): TaskLocalState

open override fun getLogger(): Logger

open override fun getLogging(): LoggingManager

getMustRunAfter

open override fun getMustRunAfter(): TaskDependency

open override fun getName(): String

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

open override fun getOutputs(): TaskOutputsInternal

open override fun getPath(): String

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

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>

open override fun hasProperty(p0: String): Boolean

open override fun hasTaskActions(): Boolean

isCompatibleWithConfigurationCache

open override fun isCompatibleWithConfigurationCache(): Boolean

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

notCompatibleWithConfigurationCache

open override fun notCompatibleWithConfigurationCache(p0: String)

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

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

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

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

open override fun setDescription(p0: String?)

open override fun setDidWork(p0: Boolean)

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

open override fun setGroup(p0: String?)

setMustRunAfter

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

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

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

setShouldRunAfter

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

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

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

Properties

@get:Optional

@get:InputDirectory

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val cacheRoot: DirectoryProperty

@get:Internal

var enabled: Boolean

@Input

val failOnWarning: Property<Boolean>

Whether to fail documentation generation if Dokka has emitted a warning or an error. Will wait until all errors and warnings have been emitted first.

hasCustomActions

val hasCustomActions: Boolean

impliesSubProjects

var impliesSubProjects: Boolean

@Input

val moduleName: Property<String>

Display name used to refer to the module. Used for ToC, navigation, logging, etc.

@Input

val moduleVersion: Property<String>

Module version.

@Input

val offlineMode: Property<Boolean>

Whether to resolve remote files/links over network.

outputDirectory

@get:OutputDirectory

abstract val outputDirectory: DirectoryProperty

Directory to which documentation will be generated, regardless of format. Can be set on per-task basis.

@Classpath

val plugins: Configuration

pluginsConfiguration

@Input

val pluginsConfiguration: ListProperty<in DokkaConfiguration.PluginConfiguration>

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

@Classpath

val runtime: Configuration

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.

val timeout: Property<Duration>

Inheritors

AbstractDokkaLeafTask

AbstractDokkaParentTask

Extensions

buildJsonConfiguration

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

Serializes DokkaConfiguration of this AbstractDokkaTask as json

gradleDokkaSourceSetBuilderFactory

fun AbstractDokkaTask.gradleDokkaSourceSetBuilderFactory(): NamedDomainObjectFactory<GradleDokkaSourceSetBuilder>