|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.gradle.api.internal.AbstractTask org.gradle.api.DefaultTask org.gradle.api.internal.ConventionTask org.gradle.api.tasks.SourceTask org.gradle.api.tasks.javadoc.Groovydoc
public class Groovydoc
Generates HTML API documentation for Groovy and Java 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. |
Field Summary |
---|
Fields inherited from interface org.gradle.api.Task |
---|
TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_NAME, TASK_OVERWRITE, TASK_TYPE |
Constructor Summary | |
---|---|
Groovydoc()
|
Method Summary | |
---|---|
protected void |
generate()
|
org.gradle.api.tasks.javadoc.AntGroovydoc |
getAntGroovydoc()
|
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 to use to locate classes referenced by the documented source. |
String |
getHeader()
Returns the html header for each page. |
Set<Groovydoc.Link> |
getLinks()
Returns 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. |
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.tasks.javadoc.AntGroovydoc antGroovydoc)
|
void |
setDestinationDir(File destinationDir)
Sets the directory to generate the documentation into. |
void |
setDocTitle(String docTitle)
Set's title for the package index(first) page (optional). |
void |
setFooter(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(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. |
void |
setLinks(Set<Groovydoc.Link> links)
Sets links to groovydoc/javadoc output at the given URL. |
void |
setOverview(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(String windowTitle)
Set's the browser window title for the documentation. |
Methods inherited from class org.gradle.api.tasks.SourceTask |
---|
exclude, exclude, exclude, exclude, getDefaultSource, getExcludes, getIncludes, getSource, include, include, include, include, setExcludes, setIncludes, setSource, source |
Methods inherited from class org.gradle.api.internal.ConventionTask |
---|
conventionMapping, getConventionMapping, setConventionMapping |
Methods inherited from class org.gradle.api.internal.AbstractTask |
---|
captureStandardOutput, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, disableStandardOutputCapture, doFirst, doFirst, doLast, doLast, equals, execute, getActions, getAdditionalProperties, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getDynamicObjectHelper, getEnabled, getExecuter, getGroup, getInputs, getLogger, getLogging, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getStandardOutputCapture, getState, getTaskDependencies, getTemporaryDir, hashCode, hasProperty, injectIntoNewInstance, isEnabled, leftShift, onlyIf, onlyIf, property, setActions, setConvention, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setGroup, setName, setOnlyIf, setOnlyIf, setProject, setProperty, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Groovydoc()
Method Detail |
---|
protected void generate()
public File getDestinationDir()
Returns the directory to generate the documentation into.
public void setDestinationDir(File destinationDir)
Sets the directory to generate the documentation into.
public FileCollection getGroovyClasspath()
Returns the classpath to use to locate classes referenced by the documented source.
public void setGroovyClasspath(FileCollection groovyClasspath)
Sets the classpath to use to locate classes referenced by the documented source.
public org.gradle.api.tasks.javadoc.AntGroovydoc getAntGroovydoc()
public void setAntGroovydoc(org.gradle.api.tasks.javadoc.AntGroovydoc antGroovydoc)
public boolean isUse()
public void setUse(boolean use)
public String getWindowTitle()
public void setWindowTitle(String windowTitle)
windowTitle
- A text for the windows titlepublic String getDocTitle()
public void setDocTitle(String docTitle)
docTitle
- the docTitle as html-codepublic String getHeader()
public void setHeader(String header)
header
- the header as html-codepublic String getFooter()
public void setFooter(String footer)
footer
- the footer as html-codepublic String getOverview()
public void setOverview(String overview)
public boolean isIncludePrivate()
public void setIncludePrivate(boolean includePrivate)
public Set<Groovydoc.Link> getLinks()
public void setLinks(Set<Groovydoc.Link> links)
links
- The links to setlink(String, String[])
public void link(String url, String... packages)
url
- Base URL of external sitepackages
- list of package prefixes
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |