|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.gradle.api.internal.ConventionTask org.gradle.api.tasks.SourceTask org.gradle.api.tasks.javadoc.Groovydoc
public class Groovydoc extends SourceTask
This task generates html api doc for Groovy classes. It uses Groovy's Groovydoc tool for this. 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.
Nested Class Summary | |
---|---|
static class |
Groovydoc.Link
A Link class represent a link between groovydoc/javadoc output and url. |
Constructor Summary | |
Groovydoc()
|
Method Summary | |
---|---|
protected void
|
generate()
|
AntGroovydoc
|
getAntGroovydoc()
|
java.io.File
|
getDestinationDir()
Returns the directory to generate the documentation into. |
java.lang.String
|
getDocTitle()
Returns the title for the package index(first) page. |
java.lang.String
|
getFooter()
Returns the html footer for each page. |
FileCollection
|
getGroovyClasspath()
Returns the classpath to use to locate classes referenced by the documented source. |
java.lang.String
|
getHeader()
Returns the html header for each page. |
java.util.Set
|
getLinks()
Returns links to groovydoc/javadoc output at the given URL |
java.lang.String
|
getOverview()
Returns a html file to be used for overview documentation. |
java.lang.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(java.lang.String url, java.lang.String packages)
Add links to groovydoc/javadoc output at the given URL |
void
|
setAntGroovydoc(AntGroovydoc antGroovydoc)
|
void
|
setDestinationDir(java.io.File destinationDir)
Sets the directory to generate the documentation into. |
void
|
setDocTitle(java.lang.String docTitle)
Set's title for the package index(first) page (optional). |
void
|
setFooter(java.lang.String footer)
Set's footer text for each page (optional). |
void
|
setGroovyClasspath(FileCollection groovyClasspath)
Sets the classpath to use to locate classes referenced by the documented source. |
void
|
setHeader(java.lang.String header)
Set's header text for each page (optional). |
void
|
setIncludePrivate(boolean includePrivate)
Set's whether to include all classes and members (i.e. including private ones) if set to true. |
void
|
setLinks(java.util.Set links)
Sets links to groovydoc/javadoc output at the given URL |
void
|
setOverview(java.lang.String overview)
Set's a html file to be used for overview documentation (optional). |
void
|
setUse(boolean use)
Set's whether to create class and package usage pages. |
void
|
setWindowTitle(java.lang.String windowTitle)
Set's the browser window title for the documentation. |
Methods inherited from class SourceTask | |
---|---|
exclude, exclude, exclude, exclude, getDefaultSource, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source |
Constructor Detail |
---|
public Groovydoc()
Method Detail |
---|
@TaskAction protected void generate()
public AntGroovydoc getAntGroovydoc()
@OutputDirectory public java.io.File getDestinationDir()
Returns the directory to generate the documentation into.
public java.lang.String getDocTitle()
public java.lang.String getFooter()
@InputFiles public FileCollection getGroovyClasspath()
Returns the classpath to use to locate classes referenced by the documented source.
public java.lang.String getHeader()
public java.util.Set getLinks()
public java.lang.String getOverview()
public java.lang.String getWindowTitle()
public boolean isIncludePrivate()
public boolean isUse()
public void link(java.lang.String url, java.lang.String packages)
url
- Base URL of external sitepackages
- list of package prefixes
public void setAntGroovydoc(AntGroovydoc antGroovydoc)
public void setDestinationDir(java.io.File destinationDir)
Sets the directory to generate the documentation into.
public void setDocTitle(java.lang.String docTitle)
docTitle
- the docTitle as html-code
public void setFooter(java.lang.String footer)
footer
- the footer as html-code
public void setGroovyClasspath(FileCollection groovyClasspath)
Sets the classpath to use to locate classes referenced by the documented source.
public void setHeader(java.lang.String header)
header
- the header as html-code
public void setIncludePrivate(boolean includePrivate)
public void setLinks(java.util.Set links)
links
- The links to set
public void setOverview(java.lang.String overview)
public void setUse(boolean use)
public void setWindowTitle(java.lang.String windowTitle)
windowTitle
- A text for the windows title
Groovy Documentation