Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.codehaus.groovy.tools.groovydoc
[Java] Class SimpleGroovyRootDoc

java.lang.Object
  org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
      org.codehaus.groovy.tools.groovydoc.SimpleGroovyRootDoc
All Implemented Interfaces:
GroovyRootDoc
public class SimpleGroovyRootDoc
extends SimpleGroovyDoc
Constructor Summary
SimpleGroovyRootDoc(java.lang.String name)

 
Method Summary
GroovyClassDoc classNamed(java.lang.String name)

GroovyClassDoc classNamedExact(java.lang.String name)

GroovyClassDoc[] classes()

java.lang.String description()

java.util.Map getVisibleClasses(java.util.List importedClassesAndPackages)

java.lang.String[] options()

GroovyPackageDoc packageNamed(java.lang.String packageName)

void printError(java.lang.String arg0)

void printNotice(java.lang.String arg0)

void printWarning(java.lang.String arg0)

void put(java.lang.String packageName, GroovyPackageDoc packageDoc)

void putAllClasses(java.util.Map classes)

void resolve()

void setDescription(java.lang.String description)

GroovyClassDoc[] specifiedClasses()

GroovyPackageDoc[] specifiedPackages()

java.lang.String summary()

 
Methods inherited from class SimpleGroovyDoc
calculateFirstSentence, commentText, compareTo, firstSentenceCommentText, getRawCommentText, getTypeDescription, getTypeSourceDescription, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, isScript, name, setCommentText, setDeprecated, setFirstSentenceCommentText, setRawCommentText, setScript, setTokenType, tags, toString, tokenType
 
Methods inherited from class java.lang.Object
java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Constructor Detail

SimpleGroovyRootDoc

public SimpleGroovyRootDoc(java.lang.String name)

 
Method Detail

classNamed

public GroovyClassDoc classNamed(java.lang.String name)

classNamedExact

public GroovyClassDoc classNamedExact(java.lang.String name)

classes

public GroovyClassDoc[] classes()

description

public java.lang.String description()

getVisibleClasses

public java.util.Map getVisibleClasses(java.util.List importedClassesAndPackages)

options

public java.lang.String[] options()

packageNamed

public GroovyPackageDoc packageNamed(java.lang.String packageName)

printError

public void printError(java.lang.String arg0)

printNotice

public void printNotice(java.lang.String arg0)

printWarning

public void printWarning(java.lang.String arg0)

put

public void put(java.lang.String packageName, GroovyPackageDoc packageDoc)

putAllClasses

public void putAllClasses(java.util.Map classes)

resolve

public void resolve()

setDescription

public void setDescription(java.lang.String description)

specifiedClasses

public GroovyClassDoc[] specifiedClasses()

specifiedPackages

public GroovyPackageDoc[] specifiedPackages()

summary

public java.lang.String summary()

 

Groovy Documentation