|
||||||||||
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.
Nested Class Summary | |
---|---|
static class |
Groovydoc.LinkArgument
Represents a link pair (href, packages). |
Field Summary | |
---|---|
private java.io.File |
destDir
|
private java.util.List |
excludePackageNames
|
private boolean |
includeNoSourcePackages
|
private java.util.List |
links
|
private LoggingHelper |
log
|
private java.util.List |
packageNames
|
private java.util.List |
packageSets
|
private boolean |
privateScope
|
private java.util.List |
sourceFilesToDoc
|
private org.apache.tools.ant.types.Path |
sourcePath
|
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 | |
---|---|
Groovydoc.LinkArgument |
createLink()
Create link to Javadoc/GroovyDoc output at the given URL. |
void |
execute()
|
private void |
parsePackages(java.util.List resultantPackages,
org.apache.tools.ant.types.Path sp)
Add the directories matched by the nested dirsets to the Vector and the base directories of the dirsets to the Path. |
void |
setDestdir(java.io.File dir)
Set the directory where the Javadoc output will be generated. |
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 |
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 final LoggingHelper log
private org.apache.tools.ant.types.Path sourcePath
private java.io.File destDir
private java.util.List packageNames
private java.util.List excludePackageNames
private java.lang.String windowTitle
private boolean privateScope
private boolean useDefaultExcludes
private boolean includeNoSourcePackages
private java.util.List packageSets
private java.util.List sourceFilesToDoc
private java.util.List links
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 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 setPrivate(boolean b)
b
- true if scope is to be private level.private void parsePackages(java.util.List resultantPackages, org.apache.tools.ant.types.Path sp)
public void execute() throws org.apache.tools.ant.BuildException
execute
in class org.apache.tools.ant.Task
org.apache.tools.ant.BuildException
public Groovydoc.LinkArgument createLink()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |