Class GroovyDocTool
java.lang.Object
org.codehaus.groovy.tools.groovydoc.GroovyDocTool
- 
Field SummaryFields
- 
Constructor SummaryConstructorsConstructorDescriptionGroovyDocTool(String[] sourcepaths) Constructor for use by people who only want to interact with the Groovy Doclet Tree (rootDoc)GroovyDocTool(ResourceManager resourceManager, String[] sourcepaths, String classTemplate) GroovyDocTool(ResourceManager resourceManager, String[] sourcepaths, String[] docTemplates, String[] packageTemplates, String[] classTemplates, List<LinkArgument> links, String javaVersion, Properties properties) Constructs a GroovyDocTool instance with the specified parameters.
- 
Method Summary
- 
Field Details- 
properties
 
- 
- 
Constructor Details- 
GroovyDocToolConstructor 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
 
- 
GroovyDocTool
- 
GroovyDocToolpublic GroovyDocTool(ResourceManager resourceManager, String[] sourcepaths, String[] docTemplates, String[] packageTemplates, String[] classTemplates, List<LinkArgument> links, String javaVersion, Properties properties) Constructs a GroovyDocTool instance with the specified parameters.- Parameters:
- resourceManager- the resource manager for handling resources, or null if not required
- sourcepaths- the paths to the source files to be processed
- docTemplates- the templates for generating documentation
- packageTemplates- the templates for generating package-level documentation
- classTemplates- the templates for generating class-level documentation
- links- a list of link arguments for external references
- javaVersion- the Java version to be used for parsing and processing Java source files
- properties- additional properties to be used when generating the groovydoc
 
 
- 
- 
Method Details- 
add- Throws:
- IOException
 
- 
getRootDoc
- 
renderToOutput- Throws:
- Exception
 
 
-