Class SimpleGroovyRootDoc
- java.lang.Object
- 
- org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
- 
- org.codehaus.groovy.tools.groovydoc.SimpleGroovyRootDoc
 
 
- 
- All Implemented Interfaces:
- Comparable,- GroovyDoc,- GroovyDocErrorReporter,- GroovyRootDoc
 
 public class SimpleGroovyRootDoc extends SimpleGroovyDoc implements GroovyRootDoc 
- 
- 
Field Summary- 
Fields inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyDocANNOTATION_DEF, CLASS_DEF, ENUM_DEF, INTERFACE_DEF, TRAIT_DEF
 
- 
 - 
Constructor SummaryConstructors Constructor Description SimpleGroovyRootDoc(String name)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description GroovyClassDoc[]classes()GroovyClassDocclassNamed(GroovyClassDoc groovyClassDoc, String name)GroovyClassDocclassNamedExact(String name)Stringdescription()Map<String,GroovyClassDoc>getResolvedClasses()Map<String,GroovyClassDoc>getVisibleClasses(List importedClassesAndPackages)String[][]options()GroovyPackageDocpackageNamed(String packageName)voidprintError(String arg0)voidprintNotice(String arg0)voidprintWarning(String arg0)voidput(String packageName, GroovyPackageDoc packageDoc)voidputAllClasses(Map<String,GroovyClassDoc> classes)voidresolve()voidsetDescription(String description)GroovyClassDoc[]specifiedClasses()GroovyPackageDoc[]specifiedPackages()Stringsummary()- 
Methods inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoccalculateFirstSentence, commentText, compareTo, firstSentenceCommentText, getRawCommentText, getTypeDescription, getTypeSourceDescription, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, isScript, isTrait, name, setCommentText, setDeprecated, setFirstSentenceCommentText, setRawCommentText, setScript, setTokenType, tags, tokenType, toString
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface java.lang.ComparablecompareTo
 - 
Methods inherited from interface org.codehaus.groovy.groovydoc.GroovyDoccommentText, firstSentenceCommentText, getRawCommentText, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, setRawCommentText
 
- 
 
- 
- 
- 
Constructor Detail- 
SimpleGroovyRootDocpublic SimpleGroovyRootDoc(String name) 
 
- 
 - 
Method Detail- 
classNamedpublic GroovyClassDoc classNamed(GroovyClassDoc groovyClassDoc, String name) - Specified by:
- classNamedin interface- GroovyRootDoc
 
 - 
classNamedExactpublic GroovyClassDoc classNamedExact(String name) 
 - 
setDescriptionpublic void setDescription(String description) 
 - 
descriptionpublic String description() 
 - 
summarypublic String summary() 
 - 
classespublic GroovyClassDoc[] classes() - Specified by:
- classesin interface- GroovyRootDoc
 
 - 
optionspublic String[][] options() - Specified by:
- optionsin interface- GroovyRootDoc
 
 - 
packageNamedpublic GroovyPackageDoc packageNamed(String packageName) - Specified by:
- packageNamedin interface- GroovyRootDoc
 
 - 
putAllClassespublic void putAllClasses(Map<String,GroovyClassDoc> classes) 
 - 
putpublic void put(String packageName, GroovyPackageDoc packageDoc) 
 - 
specifiedClassespublic GroovyClassDoc[] specifiedClasses() - Specified by:
- specifiedClassesin interface- GroovyRootDoc
 
 - 
specifiedPackagespublic GroovyPackageDoc[] specifiedPackages() - Specified by:
- specifiedPackagesin interface- GroovyRootDoc
 
 - 
getVisibleClassespublic Map<String,GroovyClassDoc> getVisibleClasses(List importedClassesAndPackages) - Specified by:
- getVisibleClassesin interface- GroovyRootDoc
 
 - 
getResolvedClassespublic Map<String,GroovyClassDoc> getResolvedClasses() - Specified by:
- getResolvedClassesin interface- GroovyRootDoc
 
 - 
printErrorpublic void printError(String arg0) - Specified by:
- printErrorin interface- GroovyDocErrorReporter
 
 - 
printNoticepublic void printNotice(String arg0) - Specified by:
- printNoticein interface- GroovyDocErrorReporter
 
 - 
printWarningpublic void printWarning(String arg0) - Specified by:
- printWarningin interface- GroovyDocErrorReporter
 
 - 
resolvepublic void resolve() 
 
- 
 
-