|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.javadoc.Javadoc
public class Javadoc
Generates Javadoc from a number of java source directories.
Field Summary |
---|
Fields inherited from interface org.gradle.api.Task |
---|
AUTOSKIP_PROPERTY_PREFIX, TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_NAME, TASK_OVERWRITE, TASK_TYPE |
Constructor Summary | |
---|---|
Javadoc(Project project,
java.lang.String name)
|
Method Summary | |
---|---|
Javadoc |
alwaysAppendDefaultClasspath()
|
Javadoc |
alwaysAppendDefaultSourcepath()
|
void |
exclude(java.lang.String... exclude)
|
java.io.File |
getClassesDir()
|
java.util.Set<java.io.File> |
getClasspath()
Returns the classpath to use to locate classes referenced by the documented source. |
FileCollection |
getConfiguration()
|
java.io.File |
getDestinationDir()
Returns the directory to generate the documentation into. |
java.util.List<java.lang.String> |
getExclude()
|
java.lang.String |
getMaxMemory()
Returns the amount of memory allocated to this task. |
MinimalJavadocOptions |
getOptions()
|
java.lang.String |
getOptionsFilename()
|
java.util.List<java.io.File> |
getSrcDirs()
Returns the source directories containing the java source files to generate documentation for. |
java.lang.String |
getTitle()
Returns the title for the generated documentation. |
boolean |
isAlwaysAppendDefaultClasspath()
|
boolean |
isAlwaysAppendDefaultSourcepath()
|
boolean |
isFailOnError()
|
boolean |
isVerbose()
Returns whether javadoc generation is accompanied by verbose output. |
void |
setAlwaysAppendDefaultClasspath(boolean alwaysAppendDefaultClasspath)
|
void |
setAlwaysAppendDefaultSourcepath(boolean alwaysAppendDefaultSourcepath)
|
void |
setConfiguration(FileCollection configuration)
|
void |
setDestinationDir(java.io.File destinationDir)
Sets the directory to generate the documentation into. |
void |
setFailOnError(boolean failOnError)
|
void |
setMaxMemory(java.lang.String maxMemory)
Sets the amount of memory allocated to this task. |
void |
setOptions(MinimalJavadocOptions options)
|
void |
setOptionsFilename(java.lang.String optionsFilename)
|
void |
setSrcDirs(java.util.List<java.io.File> srcDirs)
Sets the source directories containing the java source files to generate documentation for. |
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 org.gradle.api.internal.ConventionTask |
---|
conv, conventionMapping, conventionMapping, conventionProperty, getConventionAwareHelper, getConventionMapping, setConventionAwareHelper, setConventionMapping |
Methods inherited from class org.gradle.api.DefaultTask |
---|
configure, doFirst, doLast, leftShift, methodMissing, propertyMissing, setProperty |
Methods inherited from class org.gradle.api.internal.AbstractTask |
---|
captureStandardOutput, compareTo, defineProperty, deleteAllActions, dependsOn, dependsOnTaskDidWork, disableStandardOutputCapture, doFirst, doLast, equals, execute, getActions, getAdditionalProperties, getAnt, getConvention, getDependsOn, getDescription, getDidWork, getDynamicObjectHelper, getEnabled, getExecuted, getLogger, getName, getPath, getProject, getSkipProperties, getStandardOutputCapture, getTaskDependencies, hashCode, hasProperty, isDidWork, isEnabled, isExecuted, onlyIf, onlyIf, property, setActions, setAdditionalProperties, setDependsOn, setDescription, setDidWork, setEnabled, setExecuted, setName, setProject, setSkipProperties, setStandardOutputCapture, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface groovy.lang.GroovyObject |
---|
getMetaClass, getProperty, invokeMethod, setMetaClass |
Constructor Detail |
---|
public Javadoc(Project project, java.lang.String name)
Method Detail |
---|
public java.util.List<java.io.File> getSrcDirs()
Returns the source directories containing the java source files to generate documentation for.
public void setSrcDirs(java.util.List<java.io.File> srcDirs)
Sets the source directories containing the java source files to generate documentation for.
public java.io.File getClassesDir()
public java.io.File getDestinationDir()
Returns the directory to generate the documentation into.
public void setDestinationDir(java.io.File destinationDir)
Sets the directory to generate the documentation into.
public java.util.Set<java.io.File> getClasspath()
Returns the classpath to use to locate classes referenced by the documented source.
public java.lang.String getMaxMemory()
public void setMaxMemory(java.lang.String maxMemory)
maxMemory
- The amount of memorypublic java.lang.String getTitle()
Returns the title for the generated documentation.
public void setTitle(java.lang.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 java.util.List<java.lang.String> getExclude()
public void exclude(java.lang.String... exclude)
public FileCollection getConfiguration()
public void setConfiguration(FileCollection configuration)
public MinimalJavadocOptions getOptions()
public void setOptions(MinimalJavadocOptions options)
public boolean isFailOnError()
public void setFailOnError(boolean failOnError)
public java.lang.String getOptionsFilename()
public void setOptionsFilename(java.lang.String optionsFilename)
public boolean isAlwaysAppendDefaultSourcepath()
public void setAlwaysAppendDefaultSourcepath(boolean alwaysAppendDefaultSourcepath)
public Javadoc alwaysAppendDefaultSourcepath()
public boolean isAlwaysAppendDefaultClasspath()
public void setAlwaysAppendDefaultClasspath(boolean alwaysAppendDefaultClasspath)
public Javadoc alwaysAppendDefaultClasspath()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |