org.codehaus.groovy.tools.groovydoc
Class GroovyDocTool

java.lang.Object
  extended by org.codehaus.groovy.tools.groovydoc.GroovyDocTool

public class GroovyDocTool
extends java.lang.Object

Author:
Jeremy Rayner

Field Summary
private  GroovyRootDocBuilder rootDocBuilder
           
private  GroovyDocTemplateEngine templateEngine
           
 
Constructor Summary
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)
           
GroovyDocTool(java.lang.String[] sourcepaths)
          Constructor for use by people who only want to interact with the Groovy Doclet Tree (rootDoc)
 
Method Summary
 void add(java.util.List<java.lang.String> filenames)
           
(package private)  java.lang.String getFile(java.lang.String filename)
           
(package private)  java.lang.String getPath(java.lang.String filename)
           
 GroovyRootDoc getRootDoc()
           
 void renderToOutput(OutputTool output, java.lang.String destdir)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

rootDocBuilder

private final GroovyRootDocBuilder rootDocBuilder

templateEngine

private final GroovyDocTemplateEngine templateEngine
Constructor Detail

GroovyDocTool

public 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

GroovyDocTool

public GroovyDocTool(ResourceManager resourceManager,
                     java.lang.String[] sourcepaths,
                     java.lang.String classTemplate)

GroovyDocTool

public 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 Detail

add

public void add(java.util.List<java.lang.String> filenames)
         throws antlr.RecognitionException,
                antlr.TokenStreamException,
                java.io.IOException
Throws:
antlr.RecognitionException
antlr.TokenStreamException
java.io.IOException

getRootDoc

public GroovyRootDoc getRootDoc()

renderToOutput

public void renderToOutput(OutputTool output,
                           java.lang.String destdir)
                    throws java.lang.Exception
Throws:
java.lang.Exception

getPath

java.lang.String getPath(java.lang.String filename)

getFile

java.lang.String getFile(java.lang.String filename)


Copyright © ${year} The Codehaus. All Rights Reserved.