org.codehaus.groovy.ant
public class Groovydoc extends org.apache.tools.ant.Task
Constructor and Description |
---|
Groovydoc() |
Modifier and Type | Method and Description |
---|---|
LinkArgument |
createLink()
Create link to Javadoc/GroovyDoc output at the given URL.
|
void |
execute() |
void |
setAuthor(boolean author)
If set to false, author will not be displayed.
|
void |
setDestdir(java.io.File dir)
Set the directory where the Groovydoc output will be generated.
|
void |
setDoctitle(java.lang.String htmlTitle)
Set the title for the overview page.
|
void |
setFooter(java.lang.String footer)
Set the footer to place at the bottom of each generated html page.
|
void |
setHeader(java.lang.String header)
Specifies the header text to be placed at the top of each output file.
|
void |
setOverview(java.io.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(java.lang.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 |
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(org.apache.tools.ant.types.Path src)
Specify where to find source file
|
void |
setUse(boolean b) |
void |
setWindowtitle(java.lang.String title)
Set the title to be placed in the HTML <title> tag of the
generated documentation.
|
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(org.apache.tools.ant.types.Path src)
src
- a Path instance containing the various source directories.public void setDestdir(java.io.File dir)
dir
- the destination directory.public void setAuthor(boolean author)
author
- new valuepublic void setPackagenames(java.lang.String packages)
packages
- a comma separated list of packages specs
(may be wildcarded).public void setUse(boolean b)
public void setWindowtitle(java.lang.String title)
title
- the window title to use.public void setDoctitle(java.lang.String htmlTitle)
htmlTitle
- the html to use for the title.public void setOverview(java.io.File file)
file
- the overview filepublic 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(java.lang.String footer)
footer
- the footer valuepublic void setHeader(java.lang.String header)
header
- the header valuepublic void execute() throws org.apache.tools.ant.BuildException
execute
in class org.apache.tools.ant.Task
org.apache.tools.ant.BuildException
public LinkArgument createLink()