|
Groovy Documentation | |||||||
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
class Javadoc extends ConventionTask
Generates Javadoc from a number of java source directories.
Constructor Summary | |
Javadoc(Project project, java.lang.String name)
|
Method Summary | |
---|---|
Javadoc
|
alwaysAppendDefaultClasspath()
|
Javadoc
|
alwaysAppendDefaultSourcepath()
|
void
|
exclude(java.lang.String exclude)
|
File
|
getClassesDir()
|
java.util.Set
|
getClasspath()
Returns the classpath to use to locate classes referenced by the documented source. |
FileCollection
|
getConfiguration()
|
File
|
getDestinationDir()
Returns the directory to generate the documentation into. |
java.util.List
|
getExclude()
|
ExistingDirsFilter
|
getExistentDirsFilter()
|
java.lang.String
|
getMaxMemory()
Returns the amount of memory allocated to this task. |
MinimalJavadocOptions
|
getOptions()
|
java.lang.String
|
getOptionsFilename()
|
java.util.List
|
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(File destinationDir)
Sets the directory to generate the documentation into. |
void
|
setExistentDirsFilter(ExistingDirsFilter existentDirsFilter)
|
void
|
setFailOnError(boolean failOnError)
|
void
|
setJavadocExecHandleBuilder(JavadocExecHandleBuilder javadocExecHandleBuilder)
|
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 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 ConventionTask | |
---|---|
conv, conventionMapping, conventionMapping, conventionProperty, getConventionAwareHelper, getConventionMapping, setConventionAwareHelper, setConventionMapping |
Methods inherited from class DefaultTask | |
---|---|
leftShift, methodMissing, propertyMissing |
Methods inherited from class java.lang.Object | |
---|---|
hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll |
Constructor Detail |
---|
public Javadoc(Project project, java.lang.String name)
Method Detail |
---|
public Javadoc alwaysAppendDefaultClasspath()
public Javadoc alwaysAppendDefaultSourcepath()
public void exclude(java.lang.String exclude)
public File getClassesDir()
public java.util.Set getClasspath()
Returns the classpath to use to locate classes referenced by the documented source.
public FileCollection getConfiguration()
public File getDestinationDir()
Returns the directory to generate the documentation into.
public java.util.List getExclude()
public ExistingDirsFilter getExistentDirsFilter()
public java.lang.String getMaxMemory()
public MinimalJavadocOptions getOptions()
public java.lang.String getOptionsFilename()
public java.util.List getSrcDirs()
Returns the source directories containing the java source files to generate documentation for.
public java.lang.String getTitle()
Returns the title for the generated documentation.
public boolean isAlwaysAppendDefaultClasspath()
public boolean isAlwaysAppendDefaultSourcepath()
public boolean isFailOnError()
public boolean isVerbose()
public void setAlwaysAppendDefaultClasspath(boolean alwaysAppendDefaultClasspath)
public void setAlwaysAppendDefaultSourcepath(boolean alwaysAppendDefaultSourcepath)
public void setConfiguration(FileCollection configuration)
public void setDestinationDir(File destinationDir)
Sets the directory to generate the documentation into.
public void setExistentDirsFilter(ExistingDirsFilter existentDirsFilter)
public void setFailOnError(boolean failOnError)
public void setJavadocExecHandleBuilder(JavadocExecHandleBuilder javadocExecHandleBuilder)
public void setMaxMemory(java.lang.String maxMemory)
public void setOptions(MinimalJavadocOptions options)
public void setOptionsFilename(java.lang.String optionsFilename)
public void setSrcDirs(java.util.List srcDirs)
Sets the source directories containing the java source files to generate documentation for.
public void setTitle(java.lang.String title)
Sets the title for the generated documentation.
public void setVerbose(boolean verbose)
Groovy Documentation