|
|||||
FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Access to the GroovyDoc tool from Ant.
Field Summary | |
---|---|
File |
destDir
|
List |
excludePackageNames
|
boolean |
includeNoSourcePackages
|
List |
links
|
LoggingHelper |
log
|
List |
packageNames
|
List |
packageSets
|
boolean |
privateScope
|
List |
sourceFilesToDoc
|
Path |
sourcePath
|
boolean |
useDefaultExcludes
|
String |
windowTitle
|
Constructor Summary | |
Groovydoc()
|
Method Summary | |
---|---|
LinkArgument |
createLink()
Create link to Javadoc/GroovyDoc output at the given URL. |
void |
execute()
|
void |
parsePackages(List resultantPackages, 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(File dir)
Set the directory where the Javadoc output will be generated. |
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 |
setSourcepath(Path src)
Specify where to find source file |
void |
setUse(boolean b)
|
void |
setWindowtitle(String title)
Set the title to be placed in the HTML <title> tag of the generated documentation. |
Constructor Detail |
---|
public Groovydoc()
Method Detail |
---|
public LinkArgument createLink()
public void execute()
void parsePackages(List resultantPackages, Path sp)
public void setDestdir(File dir)
public void setPackagenames(String packages)
public void setPrivate(boolean b)
public void setSourcepath(Path src)
public void setUse(boolean b)
public void setWindowtitle(String title)