Package org.codehaus.groovy.tools.groovydoc

Interface GroovyDocParserI

All Known Implementing Classes:

GroovyDocParser

public interface GroovyDocParserI

Parses a single source unit into Groovydoc class documentation objects.

Method Summary

Modifier and Type	Method	Description
Map<String,GroovyClassDoc>	getClassDocsFromSingleSource(String packagePath, String file, String src)	Parses one source unit and returns the classes discovered in it.

Method Details

getClassDocsFromSingleSource

Map<String,GroovyClassDoc> getClassDocsFromSingleSource(String packagePath,
 String file,
 String src)

Parses one source unit and returns the classes discovered in it.

Parameters:

packagePath - the package path associated with the source

file - the source file name

src - the source text to parse

Returns:

a map of discovered class names to class documentation objects