|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.codehaus.groovy.ant.Groovydoc
public class Groovydoc
Access to the GroovyDoc tool from Ant.
Field Summary | |
---|---|
private boolean |
author
|
private java.io.File |
destDir
|
private static java.lang.String |
DOCGEN_BASEDIR
|
private java.lang.String |
docTitle
|
private java.util.List<java.lang.String> |
excludePackageNames
|
private java.lang.String |
footer
|
private java.lang.String |
header
|
private boolean |
includeNoSourcePackages
|
private java.util.List<LinkArgument> |
links
|
private LoggingHelper |
log
|
private java.io.File |
overviewFile
|
private java.util.List<java.lang.String> |
packageNames
|
private boolean |
packageScope
|
private java.util.List<org.apache.tools.ant.types.DirSet> |
packageSets
|
private boolean |
privateScope
|
private boolean |
protectedScope
|
private boolean |
publicScope
|
private java.util.List<java.lang.String> |
sourceFilesToDoc
|
private org.apache.tools.ant.types.Path |
sourcePath
|
private static java.lang.String |
TEMPLATE_BASEDIR
|
private boolean |
useDefaultExcludes
|
private java.lang.String |
windowTitle
|
Fields inherited from class org.apache.tools.ant.Task |
---|
target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
---|
description, location, project |
Constructor Summary | |
---|---|
Groovydoc()
|
Method Summary | |
---|---|
LinkArgument |
createLink()
Create link to Javadoc/GroovyDoc output at the given URL. |
void |
execute()
|
private void |
parsePackages(java.util.List<java.lang.String> resultantPackages,
org.apache.tools.ant.types.Path sourcePath)
Add the directories matched by the nested dirsets to the resulting packages list and the base directories of the dirsets to the Path. |
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. |
Methods inherited from class org.apache.tools.ant.Task |
---|
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
---|
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final java.lang.String TEMPLATE_BASEDIR
private static final java.lang.String DOCGEN_BASEDIR
private final LoggingHelper log
private org.apache.tools.ant.types.Path sourcePath
private java.io.File destDir
private java.util.List<java.lang.String> packageNames
private java.util.List<java.lang.String> excludePackageNames
private java.lang.String windowTitle
private java.lang.String docTitle
private java.lang.String footer
private java.lang.String header
private boolean privateScope
private boolean protectedScope
private boolean packageScope
private boolean publicScope
private boolean useDefaultExcludes
private boolean includeNoSourcePackages
private boolean author
private java.util.List<org.apache.tools.ant.types.DirSet> packageSets
private java.util.List<java.lang.String> sourceFilesToDoc
private java.util.List<LinkArgument> links
private java.io.File overviewFile
Constructor Detail |
---|
public Groovydoc()
Method Detail |
---|
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 valueprivate void parsePackages(java.util.List<java.lang.String> resultantPackages, org.apache.tools.ant.types.Path sourcePath)
resultantPackages
- a list to which we add the packages foundsourcePath
- a path to which we add each basedir foundpublic void execute() throws org.apache.tools.ant.BuildException
execute
in class org.apache.tools.ant.Task
org.apache.tools.ant.BuildException
public LinkArgument createLink()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |