Package org.gradle.api.tasks.javadoc
Class Groovydoc
- 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
-
- All Implemented Interfaces:
Comparable<Task>,org.gradle.api.internal.DynamicObjectAware,org.gradle.api.internal.IConventionAware,org.gradle.api.internal.TaskInternal,ExtensionAware,Task,PatternFilterable,org.gradle.util.Configurable<Task>
@CacheableTask 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGroovydoc.LinkA Link class represent a link between groovydoc/javadoc output and url.-
Nested classes/interfaces inherited from interface org.gradle.api.Task
Task.Namer
-
-
Field Summary
-
Fields inherited from interface org.gradle.api.Task
TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
-
-
Constructor Summary
Constructors Constructor Description Groovydoc()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidgenerate()org.gradle.api.internal.tasks.AntGroovydocgetAntGroovydoc()FileCollectiongetClasspath()Returns the classpath used to locate classes referenced by the documented sources.FilegetDestinationDir()Returns the directory to generate the documentation into.StringgetDocTitle()Returns the title for the package index(first) page.StringgetFooter()Returns the HTML footer for each page.FileCollectiongetGroovyClasspath()Returns the classpath containing the Groovy library to be used.StringgetHeader()Returns the HTML header for each page.Set<Groovydoc.Link>getLinks()Returns the links to groovydoc/javadoc output at the given URL.TextResourcegetOverviewText()Returns a HTML text to be used for overview documentation.FileTreegetSource()Returns the source for this task, after the include and exclude patterns have been applied.StringgetWindowTitle()Returns the browser window title for the documentation.booleanisIncludePrivate()Returns whether to include all classes and members (i.e.booleanisNoTimestamp()Returns whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).booleanisNoVersionStamp()Returns whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).booleanisUse()Returns whether to create class and package usage pages.voidlink(String url, String... packages)Add links to groovydoc/javadoc output at the given URL.voidsetAntGroovydoc(org.gradle.api.internal.tasks.AntGroovydoc antGroovydoc)voidsetClasspath(FileCollection classpath)Sets the classpath used to locate classes referenced by the documented sources.voidsetDestinationDir(File destinationDir)Sets the directory to generate the documentation into.voidsetDocTitle(String docTitle)Sets title for the package index(first) page (optional).voidsetFooter(String footer)Sets footer text for each page (optional).voidsetGroovyClasspath(FileCollection groovyClasspath)Sets the classpath containing the Groovy library to be used.voidsetHeader(String header)Sets header text for each page (optional).voidsetIncludePrivate(boolean includePrivate)Sets whether to include all classes and members (i.e.voidsetLinks(Set<Groovydoc.Link> links)Sets links to groovydoc/javadoc output at the given URL.voidsetNoTimestamp(boolean noTimestamp)Sets whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).voidsetNoVersionStamp(boolean noVersionStamp)Sets whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).voidsetOverviewText(TextResource overviewText)Sets a HTML text to be used for overview documentation (optional).voidsetUse(boolean use)Sets whether to create class and package usage pages.voidsetWindowTitle(String windowTitle)Sets the browser window title for the documentation.-
Methods inherited from class org.gradle.api.tasks.SourceTask
exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, setSource, setSource, source
-
Methods inherited from class org.gradle.api.internal.ConventionTask
conventionMapping, conventionMapping, getConventionMapping
-
Methods inherited from class org.gradle.api.DefaultTask
newInputDirectory, newInputFile, newOutputDirectory, newOutputFile
-
Methods inherited from class org.gradle.api.internal.AbstractTask
appendParallelSafeAction, compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getTimeout, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString
-
-
-
-
Method Detail
-
generate
protected void generate()
-
getSource
@PathSensitive(RELATIVE) public FileTree getSource()
Returns the source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.The
PathSensitivityfor the sources is configured to bePathSensitivity.ABSOLUTE. If your sources are less strict, please change it accordingly by overriding this method in your subclass.- Overrides:
getSourcein classSourceTask- Returns:
- The source.
-
getDestinationDir
@OutputDirectory public File getDestinationDir()
Returns the directory to generate the documentation into.- Returns:
- The directory to generate the documentation into
-
setDestinationDir
public void setDestinationDir(File destinationDir)
Sets the directory to generate the documentation into.
-
getGroovyClasspath
@Classpath public FileCollection getGroovyClasspath()
Returns the classpath containing the Groovy library to be used.- Returns:
- The classpath containing the Groovy library to be used
-
setGroovyClasspath
public void setGroovyClasspath(FileCollection groovyClasspath)
Sets the classpath containing the Groovy library to be used.
-
getClasspath
@Classpath public FileCollection getClasspath()
Returns the classpath used to locate classes referenced by the documented sources.- Returns:
- The classpath used to locate classes referenced by the documented sources
-
setClasspath
public void setClasspath(FileCollection classpath)
Sets the classpath used to locate classes referenced by the documented sources.
-
getAntGroovydoc
@Internal public org.gradle.api.internal.tasks.AntGroovydoc getAntGroovydoc()
-
setAntGroovydoc
public void setAntGroovydoc(org.gradle.api.internal.tasks.AntGroovydoc antGroovydoc)
-
isUse
@Input public boolean isUse()
Returns whether to create class and package usage pages.
-
setUse
public void setUse(boolean use)
Sets whether to create class and package usage pages.
-
isNoTimestamp
@Input public boolean isNoTimestamp()
Returns whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).
-
setNoTimestamp
public void setNoTimestamp(boolean noTimestamp)
Sets whether to include timestamp within hidden comment in generated HTML (Groovy >= 2.4.6).
-
isNoVersionStamp
@Input public boolean isNoVersionStamp()
Returns whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).
-
setNoVersionStamp
public void setNoVersionStamp(boolean noVersionStamp)
Sets whether to include version stamp within hidden comment in generated HTML (Groovy >= 2.4.6).
-
getWindowTitle
@Nullable @Optional @Input public String getWindowTitle()
Returns the browser window title for the documentation. Set tonullwhen there is no window title.
-
setWindowTitle
public void setWindowTitle(@Nullable String windowTitle)
Sets the browser window title for the documentation.- Parameters:
windowTitle- A text for the windows title
-
getDocTitle
@Nullable @Optional @Input public String getDocTitle()
Returns the title for the package index(first) page. Set tonullwhen there is no document title.
-
setDocTitle
public void setDocTitle(@Nullable String docTitle)
Sets title for the package index(first) page (optional).- Parameters:
docTitle- the docTitle as HTML
-
getHeader
@Nullable @Optional @Input public String getHeader()
Returns the HTML header for each page. Set tonullwhen there is no header.
-
setHeader
public void setHeader(@Nullable String header)
Sets header text for each page (optional).- Parameters:
header- the header as HTML
-
getFooter
@Nullable @Optional @Input public String getFooter()
Returns the HTML footer for each page. Set tonullwhen there is no footer.
-
setFooter
public void setFooter(@Nullable String footer)
Sets footer text for each page (optional).- Parameters:
footer- the footer as HTML
-
getOverviewText
@Nullable @Optional public TextResource getOverviewText()
Returns a HTML text to be used for overview documentation. Set tonullwhen there is no overview text.
-
setOverviewText
public void setOverviewText(@Nullable TextResource overviewText)
Sets a HTML text to be used for overview documentation (optional).Example:
overviewText = resources.text.fromFile("/overview.html")
-
isIncludePrivate
@Input public boolean isIncludePrivate()
Returns whether to include all classes and members (i.e. including private ones).
-
setIncludePrivate
public void setIncludePrivate(boolean includePrivate)
Sets whether to include all classes and members (i.e. including private ones) if set to true.
-
getLinks
@Input public Set<Groovydoc.Link> getLinks()
Returns the links to groovydoc/javadoc output at the given URL.
-
setLinks
public void setLinks(Set<Groovydoc.Link> links)
Sets links to groovydoc/javadoc output at the given URL.- Parameters:
links- The links to set- See Also:
link(String, String...)
-
-