gradle/org.gradle.api.tasks.javadoc/Javadoc

Javadoc

abstract class Javadoc : SourceTask(source)

Generates HTML API documentation for Java classes.

If you create your own Javadoc tasks remember to specify the 'source' property! Without source the Javadoc task will not create any documentation. Example:

plugins {
    id 'java'
}

task myJavadocs(type: Javadoc) {
  source = sourceSets.main.allJava
}

An example how to create a task that runs a custom doclet implementation:

plugins {
    id 'java'
}

configurations {
  jaxDoclet
}

dependencies {
  //jaxDoclet "some.interesting:Dependency:1.0"
}

task generateRestApiDocs(type: Javadoc) {
  source = sourceSets.main.allJava
  destinationDir = reporting.file("rest-api-docs")
  options.docletpath = configurations.jaxDoclet.files.asType(List)
  options.doclet = "com.lunatech.doclets.jax.jaxrs.JAXRSDoclet"
  options.addStringOption("jaxrscontext", "http://localhost:8080/myapp")
}

Constructors

constructor()

Properties

open var classpath: FileCollection

conventionMapping

open val conventionMapping: ConventionMapping

open var description: String

@get:Nullable

open var destinationDir: File

open var enabled: Boolean

@get:Nullable

@get:Input

open var executable: String

val ExtensionAware.extra: ExtraPropertiesExtension

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

open var group: String

impliesSubProjects

open var impliesSubProjects: Boolean

val javadocTool: Property<JavadocTool>

@get:Nullable

open var maxMemory: String

val modularity: ModularitySpec

val state: TaskStateInternal

val TASK_ACTION: String = "action"

TASK_CONSTRUCTOR_ARGS

val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"

TASK_DEPENDS_ON

val TASK_DEPENDS_ON: String = "dependsOn"

TASK_DESCRIPTION

val TASK_DESCRIPTION: String = "description"

val TASK_GROUP: String = "group"

val TASK_NAME: String = "name"

val TASK_OVERWRITE: String = "overwrite"

val TASK_TYPE: String = "type"

val timeout: Property<Duration>

@get:Nullable

@get:Input

open var title: String

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

appendParallelSafeAction

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

open fun compareTo(otherTask: Task): Int

open fun configure(closure: Closure): Task

abstract fun configure(cl: Closure): T

inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

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

conventionMapping

open fun conventionMapping(property: String, mapping: Callable<out Any>): Task

open fun dependsOn(paths: Array<Any>): Task

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

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

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String)

open fun exclude(excludes: Array<String>): SourceTask

abstract fun exclude(excludes: Array<String>): PatternFilterable

open fun finalizedBy(paths: Array<Any>): Task

open fun getActions(): List<Action<in Task>>

open fun getAnt(): AntBuilder

getAsDynamicObject

open fun getAsDynamicObject(): DynamicObject

open fun getConvention(): Convention

open fun getDependsOn(): Set<Any>

getDestroyables

open fun getDestroyables(): TaskDestroyables

open fun getDidWork(): Boolean

open fun getExcludes(): Set<String>

open fun getExtensions(): ExtensionContainer

open fun getFinalizedBy(): TaskDependency

getIdentityPath

open fun getIdentityPath(): Path

open fun getIncludes(): Set<String>

open fun getInputs(): TaskInputsInternal

abstract fun getInputs(): TaskInputs

getLifecycleDependencies

open fun getLifecycleDependencies(): TaskDependencyInternal

abstract fun getLifecycleDependencies(): TaskDependency

open fun getLocalState(): TaskLocalState

open fun getLogger(): Logger

open fun getLogging(): LoggingManager

getMustRunAfter

open fun getMustRunAfter(): TaskDependency

open fun getName(): String

open fun getOnlyIf(): Spec<in TaskInternal>

open fun getOptions(): MinimalJavadocOptions

Returns the Javadoc generation options.

open fun getOptionsFile(): File

open fun getOutputs(): TaskOutputsInternal

abstract fun getOutputs(): TaskOutputs

open fun getPath(): String

open fun getProject(): Project

getReasonNotToTrackState

open fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open fun getRequiredServices(): TaskRequiredServices

getSharedResources

open fun getSharedResources(): List<ResourceLock>

abstract fun getSharedResources(): List<out ResourceLock>

getShouldRunAfter

open fun getShouldRunAfter(): TaskDependency

@PathSensitive(value = PathSensitivity.RELATIVE)

open fun getSource(): FileTree

getStandardOutputCapture

open fun getStandardOutputCapture(): StandardOutputCapture

abstract fun getState(): TaskState

open fun getTaskActions(): List<InputChangesAwareTaskAction>

getTaskDependencies

open fun getTaskDependencies(): TaskDependencyInternal

abstract fun getTaskDependencies(): TaskDependency

getTaskIdentity

open fun getTaskIdentity(): TaskIdentity<out Any>

getTemporaryDir

open fun getTemporaryDir(): File

getTemporaryDirFactory

open fun getTemporaryDirFactory(): Factory<File>

open fun hasProperty(propertyName: String): Boolean

open fun hasTaskActions(): Boolean

open fun include(includes: Array<String>): SourceTask

abstract fun include(includes: Array<String>): PatternFilterable

injectIntoNewInstance

open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T

isCompatibleWithConfigurationCache

open fun isCompatibleWithConfigurationCache(): Boolean

open fun isEnabled(): Boolean

open fun isFailOnError(): Boolean

Specifies whether this task should fail when errors are encountered during Javadoc generation.

isHasCustomActions

open fun isHasCustomActions(): Boolean

open fun ~~isVerbose~~(): Boolean

Returns whether Javadoc generation is accompanied by verbose output.

open fun mustRunAfter(paths: Array<Any>): Task

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String)

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

open fun options(@DelegatesTo(value = MinimalJavadocOptions::class) block: Closure<out Any>)

open fun options(action: Action<in MinimalJavadocOptions>)

Convenience method for configuring Javadoc generation options.

prependParallelSafeAction

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

open fun property(propertyName: String): Any

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

open fun setDependsOn(dependsOn: Iterable<out Any>)

open fun setDidWork(didWork: Boolean)

open fun setExcludes(excludes: Iterable<String>): SourceTask

abstract fun setExcludes(excludes: Iterable<String>): PatternFilterable

open fun setFailOnError(failOnError: Boolean)

open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)

open fun setIncludes(includes: Iterable<String>): SourceTask

abstract fun setIncludes(includes: Iterable<String>): PatternFilterable

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)

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

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

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)

open fun setSource(source: FileTree)

open fun ~~setVerbose~~(verbose: Boolean)

Sets whether Javadoc generation is accompanied by verbose output or not.

open fun shouldRunAfter(paths: Array<Any>): TaskDependency

open fun source(sources: Array<Any>): SourceTask

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.

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