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


Constructor Summary
GroovyDocTool(Path sourcepath)
          Constructor for use by people who only want to interact with the Groovy Doclet Tree (rootDoc)
GroovyDocTool(ResourceManager resourceManager, Path sourcepath, java.lang.String classTemplate)
           
GroovyDocTool(ResourceManager resourceManager, Path sourcepath, java.lang.String[] docTemplates, java.lang.String[] packageTemplates, java.lang.String[] classTemplates, java.util.List links)
           
 
Method Summary
 void add(java.util.List filenames)
           
 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
 

Constructor Detail

GroovyDocTool

public GroovyDocTool(Path sourcepath)
Constructor for use by people who only want to interact with the Groovy Doclet Tree (rootDoc)

Parameters:
sourcepath - where the sources to be added can be found

GroovyDocTool

public GroovyDocTool(ResourceManager resourceManager,
                     Path sourcepath,
                     java.lang.String classTemplate)

GroovyDocTool

public GroovyDocTool(ResourceManager resourceManager,
                     Path sourcepath,
                     java.lang.String[] docTemplates,
                     java.lang.String[] packageTemplates,
                     java.lang.String[] classTemplates,
                     java.util.List links)
Method Detail

add

public void add(java.util.List filenames)
         throws RecognitionException,
                TokenStreamException,
                java.io.IOException
Throws:
RecognitionException
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

Copyright © 2003-2008 The Codehaus. All rights reserved.