|
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
public class Javadoc extends SourceTask
Generates HTML API documentation for Java classes.
Method Summary | |
---|---|
protected void
|
generate()
|
FileCollection
|
getClasspath()
Returns the classpath to use to resolve type references in the source code. |
java.io.File
|
getDestinationDir()
Returns the directory to generate the documentation into. |
java.lang.String
|
getExecutable()
Returns the javadoc executable to use to generation the javadoc. |
java.lang.String
|
getMaxMemory()
Returns the amount of memory allocated to this task. |
MinimalJavadocOptions
|
getOptions()
Returns the javadoc generation options. |
java.io.File
|
getOptionsFile()
|
java.lang.String
|
getTitle()
Returns the title for the generated documentation. |
boolean
|
isFailOnError()
Specifies whether this task should fail when errors are encountered during javadoc generation. |
boolean
|
isVerbose()
Returns whether javadoc generation is accompanied by verbose output. |
void
|
setClasspath(FileCollection classpath)
Sets the classpath to use to resolve type references in this source code. |
void
|
setDestinationDir(java.io.File destinationDir)
Sets the directory to generate the documentation into. |
void
|
setExecutable(java.lang.String executable)
|
void
|
setFailOnError(boolean failOnError)
|
void
|
setMaxMemory(java.lang.String maxMemory)
Sets the amount of memory allocated to this task. |
void
|
setOptions(MinimalJavadocOptions options)
Sets the javadoc generation options. |
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, exclude, exclude, getDefaultSource, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source |
Method Detail |
---|
@TaskAction protected void generate()
@InputFiles public FileCollection getClasspath()
@OutputDirectory public java.io.File getDestinationDir()
Returns the directory to generate the documentation into.
@Input @Optional public java.lang.String getExecutable()
public java.lang.String getMaxMemory()
@Nested public MinimalJavadocOptions getOptions()
public java.io.File getOptionsFile()
@Input @Optional public java.lang.String getTitle()
Returns the title for the generated documentation.
@Input public boolean isFailOnError()
public boolean isVerbose()
public void setClasspath(FileCollection classpath)
classpath
- The classpath. Must not be null.
public void setDestinationDir(java.io.File destinationDir)
Sets the directory to generate the documentation into.
public void setExecutable(java.lang.String executable)
public void setFailOnError(boolean failOnError)
public void setMaxMemory(java.lang.String maxMemory)
maxMemory
- The amount of memory
public void setOptions(MinimalJavadocOptions options)
options
- The options. Must not be null.
public void setTitle(java.lang.String title)
Sets the title for the generated documentation.
public void setVerbose(boolean verbose)
verbose
- Whether the output should be verbose.
Groovy Documentation