Access to the GroovyDoc tool from Ant.
Constructor and description |
---|
Groovydoc
() |
Type | Name and 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 |
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. |
Methods inherited from class | Name |
---|---|
class Task |
getOwningTarget, getTaskType, setTaskType, setTaskName, setOwningTarget, getRuntimeConfigurableWrapper, setRuntimeConfigurableWrapper, maybeConfigure, reconfigure, perform, bindToOwner, getTaskName, execute, log, log, log, log, init, setProject, setLocation, getDescription, getProject, setDescription, clone, getLocation, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
class ProjectComponent |
setProject, setLocation, getDescription, getProject, setDescription, clone, log, log, getLocation, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Create link to Javadoc/GroovyDoc output at the given URL.
Creates and returns an array of class template classpath entries.
This method is meant to be overridden by custom GroovyDoc implementations, using custom class templates.
Creates and returns an array of doc template classpath entries.
This method is meant to be overridden by custom GroovyDoc implementations, using custom doc templates.
Creates and returns an array of package template classpath entries.
This method is meant to be overridden by custom GroovyDoc implementations, using custom package templates.
Indicates the access mode or scope of interest: one of public, protected, package, or private. Package scoped access is ignored for fields of Groovy classes where they correspond to properties.
access
- one of public, protected, package, or privateIf set to false, author will not be displayed. Currently not used.
author
- new valueSpecifies the charset to be used in the templates, i.e. the value output within: <meta http-equiv="Content-Type" content="text/html; charset=charset">.
charset
- the charset valueSet the directory where the Groovydoc output will be generated.
dir
- the destination directory.Set the title for the overview page.
htmlTitle
- the html to use for the title. A colon-separated list of filename extensions to look for when searching for files to process in a given directory.
Default value: .java:.groovy:.gv:.gvy:.gsh
extensions
- new valueSpecifies the file encoding to be used for generated files. If fileEncoding is missing, the charset encoding will be used for writing the files. If fileEncoding and charset are missing, the file encoding will default to Charset.defaultCharset().
fileEncoding
- the file encodingSet the footer to place at the bottom of each generated html page.
footer
- the footer valueSpecifies the header text to be placed at the top of each output file. The header will be placed to the right of the upper navigation bar. It may contain HTML tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within the header may have to be escaped.
header
- the header valueIf set to false, 'public static void main' method will not be displayed. Defaults to true. Ignored when not processing Scripts.
includeMainForScripts
- new valueSpecify the file containing the overview to be included in the generated documentation.
file
- the overview fileIndicate whether only package, protected and public classes and members are to be included in the scope processed. Package scoped access is ignored for fields of Groovy classes where they correspond to properties.
b
- true if scope includes package level classes and membersSet the package names to be processed.
packages
- a comma separated list of packages specs
(may be wildcarded).Indicate whether all classes and members are to be included in the scope processed.
b
- true if scope is to be private level.If set to false, Scripts will not be processed. Defaults to true.
processScripts
- new valueIndicate whether only protected and public classes and members are to be included in the scope processed.
b
- true if scope includes protected level classes and membersIndicate whether only public classes and members are to be included in the scope processed.
b
- true if scope only includes public level classes and membersSpecify where to find source file
src
- a Path instance containing the various source directories.Specifies a stylesheet file to use. If not specified, a default one will be generated for you.
styleSheetFile
- the css stylesheet file to useSet the title to be placed in the HTML <title> tag of the generated documentation.
title
- the window title to use.Copyright © 2003-2014 The Codehaus. All rights reserved.