org.gradle.api.tasks.javadoc
Class Javadoc

java.lang.Object
  extended by org.gradle.api.internal.AbstractTask
      extended by org.gradle.api.DefaultTask
          extended by org.gradle.api.internal.ConventionTask
              extended by org.gradle.api.tasks.SourceTask
                  extended by org.gradle.api.tasks.javadoc.Javadoc
All Implemented Interfaces:
Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Task, PatternFilterable, org.gradle.util.Configurable<Task>

public class Javadoc
extends SourceTask

Generates HTML API documentation for Java classes.


Field Summary
 
Fields inherited from interface org.gradle.api.Task
TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
 
Constructor Summary
Javadoc()
           
 
Method Summary
protected  void generate()
           
 FileCollection getClasspath()
           
 File getDestinationDir()
          Returns the directory to generate the documentation into.
 String getExecutable()
           
 String getMaxMemory()
          Returns the amount of memory allocated to this task.
 MinimalJavadocOptions getOptions()
           
 File getOptionsFile()
           
 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(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)
           
 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, getConventionMapping, setConventionMapping
 
Methods inherited from class org.gradle.api.internal.AbstractTask
captureStandardOutput, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, disableStandardOutputCapture, doFirst, doFirst, doLast, doLast, equals, execute, getActions, getAdditionalProperties, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getDynamicObjectHelper, getEnabled, getExecuter, getGroup, getInputs, getLogger, getLogging, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getStandardOutputCapture, getState, getTaskDependencies, getTemporaryDir, hashCode, hasProperty, injectIntoNewInstance, isEnabled, leftShift, onlyIf, onlyIf, property, setActions, setConvention, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setGroup, setName, setOnlyIf, setOnlyIf, setProject, setProperty, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, 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 catched by our logging.

Parameters:
verbose - Whether the output should be verbose.

getClasspath

public FileCollection getClasspath()

setClasspath

public void setClasspath(FileCollection configuration)

getOptions

public MinimalJavadocOptions getOptions()

setOptions

public void setOptions(MinimalJavadocOptions options)

isFailOnError

public boolean isFailOnError()

setFailOnError

public void setFailOnError(boolean failOnError)

getOptionsFile

public File getOptionsFile()

getExecutable

public String getExecutable()

setExecutable

public void setExecutable(String executable)