description, location, project
Constructor | Description |
---|---|
Groovydoc() |
Modifier and Type | Method | Description |
---|---|---|
LinkArgument |
createLink() |
Create link to Javadoc/GroovyDoc output at the given URL.
|
void |
execute() |
|
protected String[] |
getClassTemplates() |
Creates and returns an array of class template classpath entries.
|
protected String[] |
getDocTemplates() |
Creates and returns an array of doc template classpath entries.
|
protected String[] |
getPackageTemplates() |
Creates and returns an array of package template classpath entries.
|
void |
setAccess(String access) |
Indicates the access mode or scope of interest: one of public, protected, package, or private.
|
void |
setAuthor(boolean author) |
If set to false, author will not be displayed.
|
void |
setCharset(String charset) |
Specifies the charset to be used in the templates, i.e. the value output within:
<meta http-equiv="Content-Type" content="text/html; charset=charset">.
|
void |
setDestdir(File dir) |
Set the directory where the Groovydoc output will be generated.
|
void |
setDoctitle(String htmlTitle) |
Set the title for the overview page.
|
void |
setExtensions(String extensions) |
A colon-separated list of filename extensions to look for when searching for files to process in a given directory.
|
void |
setFileEncoding(String fileEncoding) |
Specifies the file encoding to be used for generated files.
|
void |
setFooter(String footer) |
Set the footer to place at the bottom of each generated html page.
|
void |
setHeader(String header) |
Specifies the header text to be placed at the top of each output file.
|
void |
setIncludeMainForScripts(boolean includeMainForScripts) |
If set to false, 'public static void main' method will not be displayed.
|
void |
setNoTimestamp(boolean noTimestamp) |
If set to true, hidden timestamp will not appear within generated HTML.
|
void |
setNoVersionStamp(boolean noVersionStamp) |
If set to true, hidden version stamp will not appear within generated HTML.
|
void |
setOverview(File file) |
Specify the file containing the overview to be included in the generated documentation.
|
void |
setPackage(boolean b) |
Indicate whether only package, protected and public classes and members are to be included in the scope processed.
|
void |
setPackagenames(String packages) |
Set the package names to be processed.
|
void |
setPrivate(boolean b) |
Indicate whether all classes and
members are to be included in the scope processed.
|
void |
setProcessScripts(boolean processScripts) |
If set to false, Scripts will not be processed.
|
void |
setProtected(boolean b) |
Indicate whether only protected and public classes and members are to be included in the scope processed.
|
void |
setPublic(boolean b) |
Indicate whether only public classes and members are to be included in the scope processed.
|
void |
setSourcepath(Path src) |
Specify where to find source file
|
void |
setStyleSheetFile(File styleSheetFile) |
Specifies a stylesheet file to use.
|
void |
setUse(boolean b) |
|
void |
setWindowtitle(String title) |
Set the title to be placed in the HTML <title> tag of the
generated documentation.
|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
public void setSourcepath(Path src)
src
- a Path instance containing the various source directories.public void setDestdir(File dir)
dir
- the destination directory.public void setAuthor(boolean author)
author
- new valuepublic void setNoTimestamp(boolean noTimestamp)
noTimestamp
- new valuepublic void setNoVersionStamp(boolean noVersionStamp)
noVersionStamp
- new valuepublic void setProcessScripts(boolean processScripts)
processScripts
- new valuepublic void setIncludeMainForScripts(boolean includeMainForScripts)
includeMainForScripts
- new valuepublic void setExtensions(String extensions)
.java:.groovy:.gv:.gvy:.gsh
extensions
- new valuepublic void setPackagenames(String packages)
packages
- a comma separated list of packages specs
(may be wildcarded).public void setUse(boolean b)
public void setWindowtitle(String title)
title
- the window title to use.public void setDoctitle(String htmlTitle)
htmlTitle
- the html to use for the title.public void setOverview(File file)
file
- the overview filepublic void setAccess(String access)
access
- one of public, protected, package, or privatepublic void setPrivate(boolean b)
b
- true if scope is to be private level.public void setPublic(boolean b)
b
- true if scope only includes public level classes and memberspublic void setProtected(boolean b)
b
- true if scope includes protected level classes and memberspublic void setPackage(boolean b)
b
- true if scope includes package level classes and memberspublic void setFooter(String footer)
footer
- the footer valuepublic void setHeader(String header)
header
- the header valuepublic void setCharset(String charset)
charset
- the charset valuepublic void setFileEncoding(String fileEncoding)
fileEncoding
- the file encodingpublic void setStyleSheetFile(File styleSheetFile)
styleSheetFile
- the css stylesheet file to usepublic void execute() throws BuildException
execute
in class Task
BuildException
public LinkArgument createLink()
protected String[] getPackageTemplates()
This method is meant to be overridden by custom GroovyDoc implementations, using custom package templates.
GroovyDocTemplateInfo.DEFAULT_PACKAGE_TEMPLATES
.protected String[] getDocTemplates()
This method is meant to be overridden by custom GroovyDoc implementations, using custom doc templates.
GroovyDocTemplateInfo.DEFAULT_DOC_TEMPLATES
.protected String[] getClassTemplates()
This method is meant to be overridden by custom GroovyDoc implementations, using custom class templates.
GroovyDocTemplateInfo.DEFAULT_CLASS_TEMPLATES
.