|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gradle.api.internal.ConventionTask
org.gradle.api.tasks.SourceTask
org.gradle.api.tasks.javadoc.Javadoc
class Javadoc extends SourceTask
Generates Javadoc from Java source.
Constructor Summary | |
Javadoc()
|
Method Summary | |
---|---|
protected void
|
generate()
|
FileCollection
|
getClasspath()
|
File
|
getDestinationDir()
Returns the directory to generate the documentation into. |
java.lang.String
|
getMaxMemory()
Returns the amount of memory allocated to this task. |
MinimalJavadocOptions
|
getOptions()
|
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(File destinationDir)
Sets the directory to generate the documentation into. |
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
|
setOptionsFile(File optionsFile)
|
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, getDefaultSource, getExcludes, getIncludes, getSource, include, include, setExcludes, setIncludes, setSource, source |
Constructor Detail |
---|
Javadoc()
Method Detail |
---|
@TaskAction protected void generate()
@InputFiles public FileCollection getClasspath()
@OutputDirectory public File getDestinationDir()
Returns the directory to generate the documentation into.
public java.lang.String getMaxMemory()
public MinimalJavadocOptions getOptions()
@OutputFile public File getOptionsFile()
public java.lang.String getTitle()
Returns the title for the generated documentation.
public boolean isFailOnError()
public boolean isVerbose()
public void setClasspath(FileCollection configuration)
public void setDestinationDir(File destinationDir)
Sets the directory to generate the documentation into.
public void setFailOnError(boolean failOnError)
public void setJavadocExecHandleBuilder(JavadocExecHandleBuilder javadocExecHandleBuilder)
public void setMaxMemory(java.lang.String maxMemory)
public void setOptions(MinimalJavadocOptions options)
public void setOptionsFile(File optionsFile)
public void setTitle(java.lang.String title)
Sets the title for the generated documentation.
public void setVerbose(boolean verbose)
Groovy Documentation