public class Groovydoc extends SourceTask
Generates HTML API documentation for Groovy source, and optionally, Java source.
This task uses Groovy's Groovydoc tool to generate the API documentation. Please note that the Groovydoc tool has some limitations at the moment. The version of the Groovydoc that is used, is the one from the Groovy dependency defined in the build script.
Modifier and Type | Class and Description |
---|---|
static class |
Groovydoc.Link
A Link class represent a link between groovydoc/javadoc output and url.
|
Task.Namer
source
TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
Constructor and Description |
---|
Groovydoc() |
Modifier and Type | Method and Description |
---|---|
protected void |
generate() |
org.gradle.api.internal.tasks.AntGroovydoc |
getAntGroovydoc() |
FileCollection |
getClasspath()
Returns the classpath used to locate classes referenced by the documented sources.
|
File |
getDestinationDir()
Returns the directory to generate the documentation into.
|
String |
getDocTitle()
Returns the title for the package index(first) page.
|
String |
getFooter()
Returns the HTML footer for each page.
|
FileCollection |
getGroovyClasspath()
Returns the classpath containing the Groovy library to be used.
|
String |
getHeader()
Returns the HTML header for each page.
|
Set<Groovydoc.Link> |
getLinks()
Returns the links to groovydoc/javadoc output at the given URL.
|
TextResource |
getOverviewText()
Returns a HTML text to be used for overview documentation.
|
String |
getWindowTitle()
Returns the browser window title for the documentation.
|
boolean |
isIncludePrivate()
Returns whether to include all classes and members (i.e.
|
boolean |
isNoTimestamp()
Returns whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).
|
boolean |
isNoVersionStamp()
Returns whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).
|
boolean |
isUse()
Returns whether to create class and package usage pages.
|
void |
link(String url,
String... packages)
Add links to groovydoc/javadoc output at the given URL.
|
void |
setAntGroovydoc(org.gradle.api.internal.tasks.AntGroovydoc antGroovydoc) |
void |
setClasspath(FileCollection classpath)
Sets the classpath used to locate classes referenced by the documented sources.
|
void |
setDestinationDir(File destinationDir)
Sets the directory to generate the documentation into.
|
void |
setDocTitle(String docTitle)
Sets title for the package index(first) page (optional).
|
void |
setFooter(String footer)
Sets footer text for each page (optional).
|
void |
setGroovyClasspath(FileCollection groovyClasspath)
Sets the classpath containing the Groovy library to be used.
|
void |
setHeader(String header)
Sets header text for each page (optional).
|
void |
setIncludePrivate(boolean includePrivate)
Sets whether to include all classes and members (i.e.
|
void |
setLinks(Set<Groovydoc.Link> links)
Sets links to groovydoc/javadoc output at the given URL.
|
void |
setNoTimestamp(boolean noTimestamp)
Sets whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).
|
void |
setNoVersionStamp(boolean noVersionStamp)
Sets whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).
|
void |
setOverviewText(TextResource overviewText)
Sets a HTML text to be used for overview documentation (optional).
|
void |
setUse(boolean use)
Sets whether to create class and package usage pages.
|
void |
setWindowTitle(String windowTitle)
Sets the browser window title for the documentation.
|
exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSetFactory, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source
conventionMapping, conventionMapping, getConventionMapping
addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, finalizedBy, getActionClassLoaders, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getImpliesSubProjects, getInputs, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString
protected void generate()
@OutputDirectory public File getDestinationDir()
public void setDestinationDir(File destinationDir)
@InputFiles public FileCollection getGroovyClasspath()
public void setGroovyClasspath(FileCollection groovyClasspath)
@InputFiles public FileCollection getClasspath()
public void setClasspath(FileCollection classpath)
@Internal public org.gradle.api.internal.tasks.AntGroovydoc getAntGroovydoc()
public void setAntGroovydoc(org.gradle.api.internal.tasks.AntGroovydoc antGroovydoc)
@Input public boolean isUse()
public void setUse(boolean use)
@Input public boolean isNoTimestamp()
public void setNoTimestamp(boolean noTimestamp)
@Input public boolean isNoVersionStamp()
public void setNoVersionStamp(boolean noVersionStamp)
@Input @Optional public String getWindowTitle()
null
when there is no window title.public void setWindowTitle(String windowTitle)
windowTitle
- A text for the windows title@Input @Optional public String getDocTitle()
null
when there is no document title.public void setDocTitle(String docTitle)
docTitle
- the docTitle as HTML@Input @Optional public String getHeader()
null
when there is no header.public void setHeader(String header)
header
- the header as HTML@Input @Optional public String getFooter()
null
when there is no footer.public void setFooter(String footer)
footer
- the footer as HTML@Optional public TextResource getOverviewText()
null
when there is no overview text.public void setOverviewText(TextResource overviewText)
Example: overviewText = resources.text.fromFile("/overview.html")
@Input public boolean isIncludePrivate()
public void setIncludePrivate(boolean includePrivate)
@Input public Set<Groovydoc.Link> getLinks()
public void setLinks(Set<Groovydoc.Link> links)
links
- The links to setlink(String, String...)