org.gradle.api.tasks.javadoc

Class Javadoc

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.gradle.api.tasks.SourceTask

org.gradle.api.tasks.javadoc.Javadoc

All Implemented Interfaces:

Comparable<Task>, DynamicObjectAware, IConventionAware, TaskInternal, ExtensionAware, Task, PatternFilterable, Configurable<Task>

public class Javadoc
extends SourceTask

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:

 apply plugin: 'java'

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

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

 apply plugin: '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")
 }
 

Author:

Hans Dockter

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
Javadoc()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	generate()
FileCollection	getClasspath() Returns the classpath to use to resolve type references in the source code.
File	getDestinationDir() Returns the directory to generate the documentation into.
String	getExecutable() Returns the Javadoc executable to use to generate the Javadoc.
String	getMaxMemory() Returns the amount of memory allocated to this task.
MinimalJavadocOptions	getOptions() Returns the Javadoc generation options.
File	getOptionsFile()
String	getTitle() Returns the title for the generated documentation.
boolean	isFailOnError() Specifies whether this task should fail when errors are encountered during Javadoc generation.
boolean	isVerbose() Returns whether Javadoc generation is accompanied by verbose output.
void	options(Closure block) Convenience method for configuring Javadoc generation options.
void	setClasspath(FileCollection classpath) Sets the classpath to use to resolve type references in this source code.
void	setDestinationDir(File destinationDir) Sets the directory to generate the documentation into.
void	setExecutable(String executable)
void	setFailOnError(boolean failOnError)
void	setMaxMemory(String maxMemory) Sets the amount of memory allocated to this task.
void	setOptions(MinimalJavadocOptions options) Sets the Javadoc generation options.
void	setTitle(String title) Sets the title for the generated documentation.
void	setVerbose(boolean verbose) Sets whether Javadoc generation is accompanied by verbose output or not.

Methods inherited from class org.gradle.api.tasks.SourceTask

exclude, exclude, exclude, exclude, getDefaultSource, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source

Methods inherited from class org.gradle.api.internal.ConventionTask

conventionMapping, conventionMapping, getConventionMapping

Methods inherited from class org.gradle.api.internal.AbstractTask

addValidator, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, executeWithoutThrowingTaskFailure, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getDynamicObjectHelper, getEnabled, getExecuter, getExtensions, getGroup, getInputs, getLogger, getLogging, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getStandardOutputCapture, getState, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, leftShift, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setGroup, setName, setOnlyIf, setOnlyIf, setProject, setProperty, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Javadoc

public Javadoc()

Method Detail

generate

protected void generate()

getDestinationDir

public File getDestinationDir()

Returns the directory to generate the documentation into.

Returns:

The directory.

setDestinationDir

public void setDestinationDir(File destinationDir)

Sets the directory to generate the documentation into.

getMaxMemory

public String getMaxMemory()

Returns the amount of memory allocated to this task.

setMaxMemory

public void setMaxMemory(String maxMemory)

Sets the amount of memory allocated to this task.

Parameters:

maxMemory - The amount of memory

getTitle

public String getTitle()

Returns the title for the generated documentation.

Returns:

The title, possibly null.

setTitle

public void setTitle(String title)

Sets the title for the generated documentation.

isVerbose

public boolean isVerbose()

Returns whether Javadoc generation is accompanied by verbose output.

See Also:

setVerbose(boolean)

setVerbose

public void setVerbose(boolean verbose)

Sets whether Javadoc generation is accompanied by verbose output or not. The verbose output is done via println (by the underlying Ant task). Thus it is not handled by our logging.

Parameters:

verbose - Whether the output should be verbose.

getClasspath

public FileCollection getClasspath()

Returns the classpath to use to resolve type references in the source code.

Returns:

The classpath.

setClasspath

public void setClasspath(FileCollection classpath)

Sets the classpath to use to resolve type references in this source code.

Parameters:

classpath - The classpath. Must not be null.

getOptions

public MinimalJavadocOptions getOptions()

Returns the Javadoc generation options.

Returns:

The options. Never returns null.

setOptions

public void setOptions(MinimalJavadocOptions options)

Sets the Javadoc generation options.

Parameters:

options - The options. Must not be null.

options

public void options(Closure block)

Convenience method for configuring Javadoc generation options.

Parameters:

block - The configuration block for Javadoc generation options.

isFailOnError

public boolean isFailOnError()

Specifies whether this task should fail when errors are encountered during Javadoc generation. When true, this task will fail on Javadoc error. When false, this task will ignore Javadoc errors.

setFailOnError

public void setFailOnError(boolean failOnError)

getOptionsFile

public File getOptionsFile()

getExecutable

public String getExecutable()

Returns the Javadoc executable to use to generate the Javadoc. When null, the Javadoc executable for the current JVM is used.

Returns:

The executable. May be null.

setExecutable

public void setExecutable(String executable)