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 severe limitations at the moment (for example no doc for properties comments). The version of the Groovydoc that is used, is the one from the Groovy defined in the build script. Please note also, that the Groovydoc tool prints to System.out for many of its statements and does circumvents our logging currently.
Modifiers | Name | Description |
---|---|---|
static class |
Groovydoc.Link |
A Link class represent a link between groovydoc/javadoc output and url. |
Fields inherited from class | Fields |
---|---|
class SourceTask |
source |
Constructor and description |
---|
Groovydoc
() |
Type | Name and description |
---|---|
protected void |
generate() |
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<Link> |
getLinks() Returns the links to groovydoc/javadoc output at the given URL. |
String |
getOverview() Returns a HTML file 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. including private ones). |
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(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. including private ones) if set to true. |
void |
setLinks(Set<Link> links) Sets links to groovydoc/javadoc output at the given URL. |
void |
setOverview(String overview) Sets a HTML file 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. |
Methods inherited from class | Name |
---|---|
class SourceTask |
exclude, exclude, exclude, exclude, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source |
Returns the classpath used to locate classes referenced by the documented sources.
Returns the directory to generate the documentation into.
Returns the title for the package index(first) page. Set to null
when there is no document title.
Returns the HTML footer for each page. Set to null
when there is no footer.
Returns the classpath containing the Groovy library to be used.
Returns the HTML header for each page. Set to null
when there is no header.
Returns the links to groovydoc/javadoc output at the given URL.
Returns a HTML file to be used for overview documentation. Set to null
when there is no overview file.
Returns the browser window title for the documentation. Set to null
when there is no window title.
Returns whether to include all classes and members (i.e. including private ones).
Returns whether to create class and package usage pages.
Add links to groovydoc/javadoc output at the given URL.
url
- Base URL of external sitepackages
- list of package prefixesSets the classpath used to locate classes referenced by the documented sources.
Sets the directory to generate the documentation into.
Sets title for the package index(first) page (optional).
docTitle
- the docTitle as HTMLSets footer text for each page (optional).
footer
- the footer as HTMLSets the classpath containing the Groovy library to be used.
Sets header text for each page (optional).
header
- the header as HTMLSets whether to include all classes and members (i.e. including private ones) if set to true.
Sets links to groovydoc/javadoc output at the given URL.
links
- The links to setSets a HTML file to be used for overview documentation (optional).
Sets whether to create class and package usage pages.
Sets the browser window title for the documentation.
windowTitle
- A text for the windows title