|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class Javadoc
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 |
---|
public Javadoc()
Method Detail |
---|
protected void generate()
public File getDestinationDir()
Returns the directory to generate the documentation into.
public void setDestinationDir(File destinationDir)
Sets the directory to generate the documentation into.
public String getMaxMemory()
public void setMaxMemory(String maxMemory)
maxMemory
- The amount of memorypublic String getTitle()
Returns the title for the generated documentation.
public void setTitle(String title)
Sets the title for the generated documentation.
public boolean isVerbose()
setVerbose(boolean)
public void setVerbose(boolean verbose)
verbose
- Whether the output should be verbose.public FileCollection getClasspath()
public void setClasspath(FileCollection configuration)
public MinimalJavadocOptions getOptions()
public void setOptions(MinimalJavadocOptions options)
public boolean isFailOnError()
public void setFailOnError(boolean failOnError)
public File getOptionsFile()
public String getExecutable()
public void setExecutable(String executable)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |