# Groovydoc

@CacheableTask
abstract class Groovydoc : SourceTask(source)

Generates HTML API documentation for Groovy source, and optionally, Java source.

This task uses Groovy's Groovydoc tool to generate the API documentation. Please note that the Groovydoc tool has some limitations at the moment. The version of the Groovydoc that is used, is the one from the Groovy dependency defined in the build script.

## Constructors

Groovydoc
Link copied to clipboard
constructor()

## Types

Link
Link copied to clipboard
open class Link : Serializable
A Link class represent a link between groovydoc/javadoc output and url.

## Properties

access
Link copied to clipboard
@get:Input
val access: Property<GroovydocAccess>
classpath
Link copied to clipboard
@get:Classpath
open var classpath: FileCollection
conventionMapping
Link copied to clipboard
open val conventionMapping: @Nullable ConventionMapping
description
Link copied to clipboard
open var description: @Nullable String
destinationDir
Link copied to clipboard
@get:OutputDirectory
open var destinationDir: File
docTitle
Link copied to clipboard
@get:Nullable
@get:Optional
@get:Input
open var docTitle: String
enabled
Link copied to clipboard
open var enabled: Boolean
extra
Link copied to clipboard
val ExtensionAware.extra: ExtraPropertiesExtension

The extra properties extension in this object's extension container.

footer
Link copied to clipboard
@get:Nullable
@get:Optional
@get:Input
open var footer: String
groovyClasspath
Link copied to clipboard
@get:Classpath
open var groovyClasspath: FileCollection
group
Link copied to clipboard
open var group: @Nullable String
header
Link copied to clipboard
@get:Nullable
@get:Optional
@get:Input
open var header: String
impliesSubProjects
Link copied to clipboard
open var impliesSubProjects: Boolean
includeAuthor
Link copied to clipboard
@get:Input
val includeAuthor: Property<Boolean>
includeMainForScripts
Link copied to clipboard
@get:Input
val includeMainForScripts: Property<Boolean>
links
Link copied to clipboard
@get:Input
open var links: Set<Groovydoc.Link>
processScripts
Link copied to clipboard
@get:Input
val processScripts: Property<Boolean>
state
Link copied to clipboard
val state: TaskStateInternal
TASK_ACTION
Link copied to clipboard
val TASK_ACTION: String = "action"
TASK_CONSTRUCTOR_ARGS
Link copied to clipboard
val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"
TASK_DEPENDS_ON
Link copied to clipboard
val TASK_DEPENDS_ON: String = "dependsOn"
TASK_DESCRIPTION
Link copied to clipboard
val TASK_DESCRIPTION: String = "description"
TASK_GROUP
Link copied to clipboard
val TASK_GROUP: String = "group"
TASK_NAME
Link copied to clipboard
val TASK_NAME: String = "name"
TASK_OVERWRITE
Link copied to clipboard
val TASK_OVERWRITE: String = "overwrite"
TASK_TYPE
Link copied to clipboard
val TASK_TYPE: String = "type"
timeout
Link copied to clipboard
val timeout: Property<Duration>
windowTitle
Link copied to clipboard
@get:Nullable
@get:Optional
@get:Input
open var windowTitle: String

## Functions

acceptServiceReferences
Link copied to clipboard
open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)
appendParallelSafeAction
Link copied to clipboard
open fun appendParallelSafeAction(action: Action<in Task>)
compareTo
Link copied to clipboard
open fun compareTo(otherTask: Task): Int
configure
Link copied to clipboard
open fun configure(closure: Closure): Task
abstract fun configure(cl: Closure): T
configure
Link copied to clipboard
inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

Executes the given configuration block against the extension of the specified type.

conventionMapping
Link copied to clipboard
open fun conventionMapping(property: String, mapping: Callable<out Any>): Task
dependsOn
Link copied to clipboard
open fun dependsOn(paths: Array<Any>): Task
doFirst
Link copied to clipboard
open fun doFirst(action: Action<in Task>): Task
doLast
Link copied to clipboard
open fun doLast(action: Action<in Task>): Task
doNotTrackState
Link copied to clipboard
open fun doNotTrackState(reasonNotToTrackState: String)
exclude
Link copied to clipboard
open fun exclude(excludes: Array<String>): SourceTask
abstract fun exclude(excludes: Array<String>): PatternFilterable
finalizedBy
Link copied to clipboard
open fun finalizedBy(paths: Array<Any>): Task
getActions
Link copied to clipboard
open fun getActions(): List<Action<in Task>>
getAnt
Link copied to clipboard
open fun getAnt(): AntBuilder
getAsDynamicObject
Link copied to clipboard
open fun getAsDynamicObject(): DynamicObject
getDependsOn
Link copied to clipboard
open fun getDependsOn(): Set<Any>
getDestroyables
Link copied to clipboard
open fun getDestroyables(): TaskDestroyables
getDidWork
Link copied to clipboard
open fun getDidWork(): Boolean
getExcludes
Link copied to clipboard
open fun getExcludes(): Set<String>
getExtensions
Link copied to clipboard
open fun getExtensions(): ExtensionContainer
getFinalizedBy
Link copied to clipboard
open fun getFinalizedBy(): TaskDependency
getIdentityPath
Link copied to clipboard
open fun getIdentityPath(): Path
getIncludes
Link copied to clipboard
open fun getIncludes(): Set<String>
getInputs
Link copied to clipboard
open fun getInputs(): TaskInputsInternal
abstract fun getInputs(): TaskInputs
getLifecycleDependencies
Link copied to clipboard
open fun getLifecycleDependencies(): TaskDependencyInternal
abstract fun getLifecycleDependencies(): TaskDependency
getLocalState
Link copied to clipboard
open fun getLocalState(): TaskLocalState
getLogger
Link copied to clipboard
open fun getLogger(): Logger
getLogging
Link copied to clipboard
open fun getLogging(): LoggingManager
getMustRunAfter
Link copied to clipboard
open fun getMustRunAfter(): TaskDependency
getName
Link copied to clipboard
open fun getName(): String
getOnlyIf
Link copied to clipboard
open fun getOnlyIf(): Spec<in TaskInternal>
getOutputs
Link copied to clipboard
open fun getOutputs(): TaskOutputsInternal
abstract fun getOutputs(): TaskOutputs
getOverviewText
Link copied to clipboard
@Nullable
@Optional
open fun getOverviewText(): @Nullable TextResource
Returns a HTML text to be used for overview documentation.
getPath
Link copied to clipboard
open fun getPath(): String
getProject
Link copied to clipboard
open fun getProject(): Project
getReasonNotToTrackState
Link copied to clipboard
open fun getReasonNotToTrackState(): Optional<String>
getReasonTaskIsIncompatibleWithConfigurationCache
Link copied to clipboard
open fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>
getRequiredServices
Link copied to clipboard
open fun getRequiredServices(): TaskRequiredServices
getSharedResources
Link copied to clipboard
open fun getSharedResources(): List<ResourceLock>
abstract fun getSharedResources(): List<out ResourceLock>
getShouldRunAfter
Link copied to clipboard
open fun getShouldRunAfter(): TaskDependency
getSource
Link copied to clipboard
@PathSensitive(value = PathSensitivity.RELATIVE)
open fun getSource(): FileTree
getStandardOutputCapture
Link copied to clipboard
open fun getStandardOutputCapture(): StandardOutputCapture
getState
Link copied to clipboard
abstract fun getState(): TaskState
getTaskActions
Link copied to clipboard
open fun getTaskActions(): List<InputChangesAwareTaskAction>
getTaskDependencies
Link copied to clipboard
open fun getTaskDependencies(): TaskDependencyInternal
abstract fun getTaskDependencies(): TaskDependency
getTaskIdentity
Link copied to clipboard
open fun getTaskIdentity(): TaskIdentity<out Any>
getTemporaryDir
Link copied to clipboard
open fun getTemporaryDir(): File
getTemporaryDirFactory
Link copied to clipboard
open fun getTemporaryDirFactory(): Factory<File>
hasProperty
Link copied to clipboard
open fun hasProperty(propertyName: String): Boolean
hasTaskActions
Link copied to clipboard
open fun hasTaskActions(): Boolean
include
Link copied to clipboard
open fun include(includes: Array<String>): SourceTask
abstract fun include(includes: Array<String>): PatternFilterable
injectIntoNewInstance
Link copied to clipboard
open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T
isCompatibleWithConfigurationCache
Link copied to clipboard
open fun isCompatibleWithConfigurationCache(): Boolean
isEnabled
Link copied to clipboard
open fun isEnabled(): Boolean
isHasCustomActions
Link copied to clipboard
open fun isHasCustomActions(): Boolean
isNoTimestamp
Link copied to clipboard
@Input
open fun isNoTimestamp(): Boolean
Returns whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).
isNoVersionStamp
Link copied to clipboard
@Input
open fun isNoVersionStamp(): Boolean
Returns whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).
isUse
Link copied to clipboard
@Input
open fun isUse(): Boolean
Returns whether to create class and package usage pages.
link
Link copied to clipboard
open fun link(url: String, packages: Array<String>)
Add links to groovydoc/javadoc output at the given URL.
mustRunAfter
Link copied to clipboard
open fun mustRunAfter(paths: Array<Any>): Task
notCompatibleWithConfigurationCache
Link copied to clipboard
open fun notCompatibleWithConfigurationCache(reason: String)
onlyIf
Link copied to clipboard
open fun onlyIf(spec: Spec<in Task>)
prependParallelSafeAction
Link copied to clipboard
open fun prependParallelSafeAction(action: Action<in Task>)
property
Link copied to clipboard
open fun property(propertyName: String): Any
setActions
Link copied to clipboard
open fun setActions(replacements: List<Action<in Task>>)
setDependsOn
Link copied to clipboard
open fun setDependsOn(dependsOn: Iterable<out Any>)
setDidWork
Link copied to clipboard
open fun setDidWork(didWork: Boolean)
setExcludes
Link copied to clipboard
open fun setExcludes(excludes: Iterable<String>): SourceTask
abstract fun setExcludes(excludes: Iterable<String>): PatternFilterable
setFinalizedBy
Link copied to clipboard
open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)
setIncludes
Link copied to clipboard
open fun setIncludes(includes: Iterable<String>): SourceTask
abstract fun setIncludes(includes: Iterable<String>): PatternFilterable
setMustRunAfter
Link copied to clipboard
open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)
setNoTimestamp
Link copied to clipboard
open fun setNoTimestamp(noTimestamp: Boolean)
Sets whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).
setNoVersionStamp
Link copied to clipboard
open fun setNoVersionStamp(noVersionStamp: Boolean)
Sets whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).
setOnlyIf
Link copied to clipboard
open fun setOnlyIf(spec: Spec<in Task>)
setOverviewText
Link copied to clipboard
open fun setOverviewText(@Nullable overviewText: @Nullable TextResource)
Sets a HTML text to be used for overview documentation (optional).
setProperty
Link copied to clipboard
open fun setProperty(name: String, value: Any)
setShouldRunAfter
Link copied to clipboard
open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)
setSource
Link copied to clipboard
open fun setSource(source: FileTree)
setUse
Link copied to clipboard
open fun setUse(use: Boolean)
Sets whether to create class and package usage pages.
shouldRunAfter
Link copied to clipboard
open fun shouldRunAfter(paths: Array<Any>): TaskDependency
source
Link copied to clipboard
open fun source(sources: Array<@Nullable Any>): SourceTask
the
Link copied to clipboard
inline fun <T : Any> ExtensionAware.the(): T

Returns the extension of the specified type.

fun <T : Any> ExtensionAware.the(extensionType: KClass<T>): T

Returns the extension of the specified extensionType.

usesService
Link copied to clipboard
open fun usesService(service: Provider<out BuildService<out Any>>)