Class GroovyDocTool
java.lang.Object
org.codehaus.groovy.tools.groovydoc.GroovyDocTool
public class GroovyDocTool
extends java.lang.Object
- 
Field SummaryFields Modifier and Type Field Description protected java.util.Propertiesproperties
- 
Constructor SummaryConstructors Constructor Description GroovyDocTool(java.lang.String[] sourcepaths)Constructor for use by people who only want to interact with the Groovy Doclet Tree (rootDoc)GroovyDocTool(ResourceManager resourceManager, java.lang.String[] sourcepaths, java.lang.String classTemplate)GroovyDocTool(ResourceManager resourceManager, java.lang.String[] sourcepaths, java.lang.String[] docTemplates, java.lang.String[] packageTemplates, java.lang.String[] classTemplates, java.util.List<LinkArgument> links, java.util.Properties properties)
- 
Method SummaryModifier and Type Method Description voidadd(java.util.List<java.lang.String> filenames)GroovyRootDocgetRootDoc()voidrenderToOutput(OutputTool output, java.lang.String destdir)Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
- 
Field Details- 
propertiesprotected java.util.Properties properties
 
- 
- 
Constructor Details- 
GroovyDocToolpublic GroovyDocTool(java.lang.String[] sourcepaths)Constructor for use by people who only want to interact with the Groovy Doclet Tree (rootDoc)- Parameters:
- sourcepaths- where the sources to be added can be found
 
- 
GroovyDocToolpublic GroovyDocTool(ResourceManager resourceManager, java.lang.String[] sourcepaths, java.lang.String classTemplate)
- 
GroovyDocToolpublic GroovyDocTool(ResourceManager resourceManager, java.lang.String[] sourcepaths, java.lang.String[] docTemplates, java.lang.String[] packageTemplates, java.lang.String[] classTemplates, java.util.List<LinkArgument> links, java.util.Properties properties)
 
- 
- 
Method Details- 
addpublic void add(java.util.List<java.lang.String> filenames) throws java.io.IOException- Throws:
- java.io.IOException
 
- 
getRootDoc
- 
renderToOutput- Throws:
- java.lang.Exception
 
 
-