Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.gradle.api.tasks.javadoc
[Java] Class Javadoc

java.lang.Object
  org.gradle.api.internal.ConventionTask
      org.gradle.api.tasks.SourceTask
          org.gradle.api.tasks.javadoc.Javadoc

public class Javadoc
extends SourceTask

Generates HTML API documentation for Java classes.

Authors:
Hans Dockter

Method Summary
protected void generate()

FileCollection getClasspath()

java.io.File getDestinationDir()

Returns the directory to generate the documentation into.
java.lang.String getExecutable()

java.lang.String getMaxMemory()

Returns the amount of memory allocated to this task.
MinimalJavadocOptions getOptions()

java.io.File getOptionsFile()

java.lang.String getTitle()

Returns the title for the generated documentation.
boolean isFailOnError()

boolean isVerbose()

Returns whether javadoc generation is accompanied by verbose output.
void setClasspath(FileCollection configuration)

void setDestinationDir(java.io.File destinationDir)

Sets the directory to generate the documentation into.
void setExecutable(java.lang.String executable)

void setFailOnError(boolean failOnError)

void setMaxMemory(java.lang.String maxMemory)

Sets the amount of memory allocated to this task.
void setOptions(MinimalJavadocOptions options)

void setTitle(java.lang.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 SourceTask
exclude, exclude, exclude, exclude, getDefaultSource, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source
 

Method Detail

generate

@TaskAction
protected void generate()

getClasspath

@InputFiles
public FileCollection getClasspath()

getDestinationDir

@OutputDirectory
public java.io.File getDestinationDir()

Returns the directory to generate the documentation into.

Returns:
The directory.

getExecutable

public java.lang.String getExecutable()

getMaxMemory

public java.lang.String getMaxMemory()
Returns the amount of memory allocated to this task.

getOptions

public MinimalJavadocOptions getOptions()

getOptionsFile

public java.io.File getOptionsFile()

getTitle

public java.lang.String getTitle()

Returns the title for the generated documentation.

Returns:
The title, possibly null.

isFailOnError

public boolean isFailOnError()

isVerbose

public boolean isVerbose()
Returns whether javadoc generation is accompanied by verbose output.
See Also:
setVerbose(boolean)

setClasspath

public void setClasspath(FileCollection configuration)

setDestinationDir

public void setDestinationDir(java.io.File destinationDir)

Sets the directory to generate the documentation into.

setExecutable

public void setExecutable(java.lang.String executable)

setFailOnError

public void setFailOnError(boolean failOnError)

setMaxMemory

public void setMaxMemory(java.lang.String maxMemory)
Sets the amount of memory allocated to this task.
Parameters:
maxMemory - The amount of memory

setOptions

public void setOptions(MinimalJavadocOptions options)

setTitle

public void setTitle(java.lang.String title)

Sets the title for the generated documentation.

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 catched by our logging.
Parameters:
verbose - Whether the output should be verbose.

 

Groovy Documentation