Dokkatoo Gradle Plugin/dev.adamko.dokkatoo.tasks/DokkatooGenerateTask

DokkatooGenerateTask

abstract class DokkatooGenerateTask @DokkatooInternalApi @Inject constructor(objects: ObjectFactory, archives: ArchiveOperations, workers: WorkerExecutor, pluginsConfiguration: DokkaPluginParametersContainer) : DokkatooTask(source)

Base task for executing Dokka Generator, producing documentation.

The Dokka Plugins added to the generator classpath determine the type of documentation generated.

Inheritors

DokkatooGenerateModuleTask

DokkatooGeneratePublicationTask

Constructors

DokkatooGenerateTask

@DokkatooInternalApi

@Inject

constructor(objects: ObjectFactory, archives: ArchiveOperations, workers: WorkerExecutor, pluginsConfiguration: DokkaPluginParametersContainer)

Types

GenerationType

enum ~~GenerationType~~ : Enum<DokkatooGenerateTask.GenerationType>

GeneratorMode

@DokkatooInternalApi

enum GeneratorMode : Enum<DokkatooGenerateTask.GeneratorMode>

Properties

cacheDirectory

@get:LocalState

abstract val cacheDirectory: DirectoryProperty

dokkaConfigurationJsonFile

@DokkatooInternalApi

@get:Internal

abstract val dokkaConfigurationJsonFile: RegularFileProperty

The DokkaConfiguration by Dokka Generator can be saved to a file for debugging purposes. To disable this behaviour set this property to null.

enabled

@get:Internal

var enabled: Boolean

generationType

@get:Internal

abstract val ~~generationType~~: Property<DokkatooGenerateTask.GenerationType>

Deprecated - instead use specific subtasks for Module/Publication generation.

generator

val generator: DokkaGeneratorParametersSpec

hasCustomActions

val hasCustomActions: Boolean

impliesSubProjects

var impliesSubProjects: Boolean

objects

@get:Inject

abstract val objects: ObjectFactory

outputDirectory

@get:OutputDirectory

abstract val outputDirectory: DirectoryProperty

Directory containing the generation result. The content and structure depends on whether the task generates a Dokka Module or a Dokka Publication.

publicationEnabled

@get:Input

abstract val publicationEnabled: Property<Boolean>

runtimeClasspath

@get:Classpath

abstract val runtimeClasspath: ConfigurableFileCollection

Classpath required to run Dokka Generator.

state

val state: TaskStateInternal

timeout

val timeout: Property<Duration>

workerDebugEnabled

@get:Internal

abstract val ~~workerDebugEnabled~~: Property<Boolean>

Please move worker options:

workerIsolation

abstract val workerIsolation: Property<WorkerIsolation>

Control whether Dokkatoo launches Dokka Generator.

workerJvmArgs

@get:Internal

abstract val ~~workerJvmArgs~~: ListProperty<String>

Please move worker options:

workerLogFile

@get:Internal

abstract val workerLogFile: RegularFileProperty

workerMaxHeapSize

@get:Internal

abstract val ~~workerMaxHeapSize~~: Property<String>

Please move worker options:

workerMinHeapSize

@get:Internal

abstract val ~~workerMinHeapSize~~: Property<String>

Please move worker options:

Functions

acceptServiceReferences

open override fun acceptServiceReferences(serviceReferences: MutableSet<ServiceReferenceSpec>)

appendParallelSafeAction

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

compareTo

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

configure

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

dependsOn

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

doFirst

open override fun doFirst(action: Closure<Any>): Task

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

open override fun doFirst(actionName: String, action: Action<in Task>): Task

doLast

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

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

open override fun doLast(actionName: String, action: Action<in Task>): Task

doNotTrackState

open override fun doNotTrackState(reasonNotToTrackState: String)

finalizedBy

open override fun finalizedBy(vararg paths: 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(): 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>

getReasonTaskIsIncompatibleWithConfigurationCache

open override fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open override fun getRequiredServices(): TaskRequiredServices

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>

hasProperty

open override fun hasProperty(propertyName: String): Boolean

hasTaskActions

open override fun hasTaskActions(): Boolean

isCompatibleWithConfigurationCache

open override fun isCompatibleWithConfigurationCache(): Boolean

mustRunAfter

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

notCompatibleWithConfigurationCache

open override fun notCompatibleWithConfigurationCache(reason: String)

onlyIf

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

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

open override fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)

prependParallelSafeAction

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

property

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

setActions

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

setDependsOn

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

setDescription

open override fun setDescription(description: String?)

setDidWork

open override fun setDidWork(didWork: Boolean)

setFinalizedBy

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

setGroup

open override fun setGroup(group: String?)

setMustRunAfter

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

setOnlyIf

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

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

open override fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)

setProperty

open override fun setProperty(name: String, value: Any)

setShouldRunAfter

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

shouldRunAfter

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

usesService

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