public class GroovyDocTool extends Object
| Modifiers | Name | Description |
|---|---|---|
protected Properties |
properties |
| Constructor and description |
|---|
GroovyDocTool(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. |
| Type Params | Return Type | Name and description |
|---|---|---|
|
public void |
add(List<String> filenames) |
|
public GroovyRootDoc |
getRootDoc() |
|
public void |
renderToOutput(OutputTool output, String destdir) |
Constructor for use by people who only want to interact with the Groovy Doclet Tree (rootDoc)
sourcepaths - where the sources to be added can be foundConstructs a GroovyDocTool instance with the specified parameters.
resourceManager - the resource manager for handling resources, or null if not requiredsourcepaths - the paths to the source files to be processeddocTemplates - the templates for generating documentationpackageTemplates - the templates for generating package-level documentationclassTemplates - the templates for generating class-level documentationlinks - a list of link arguments for external referencesjavaVersion - the Java version to be used for parsing and processing Java source filesproperties - additional properties to be used when generating the groovydocCopyright © 2003-2025 The Apache Software Foundation. All rights reserved.