|
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.Groovydoc
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 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 the 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)
Sets title for the package index(first) page (optional). |
void
|
setFooter(java.lang.String footer)
Sets 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)
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(java.util.Set links)
Sets links to groovydoc/javadoc output at the given URL. |
void
|
setOverview(java.lang.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(java.lang.String windowTitle)
Sets 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.
@Input @Optional public java.lang.String getDocTitle()
@Input @Optional public java.lang.String getFooter()
@InputFiles public FileCollection getGroovyClasspath()
Returns the classpath to use to locate classes referenced by the documented source.
@Input @Optional public java.lang.String getHeader()
@Input public java.util.Set getLinks()
public java.lang.String getOverview()
@Input @Optional public java.lang.String getWindowTitle()
@Input public boolean isIncludePrivate()
@Input 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