Class SimpleGroovyRootDoc
java.lang.Object
org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
org.codehaus.groovy.tools.groovydoc.SimpleGroovyRootDoc
- All Implemented Interfaces:
- java.lang.Comparable,- GroovyDoc,- GroovyDocErrorReporter,- GroovyRootDoc
public class SimpleGroovyRootDoc extends SimpleGroovyDoc implements GroovyRootDoc
- 
Field SummaryFields inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyDocANNOTATION_DEF, CLASS_DEF, ENUM_DEF, INTERFACE_DEF, TRAIT_DEF
- 
Constructor SummaryConstructors Constructor Description SimpleGroovyRootDoc(java.lang.String name)
- 
Method SummaryModifier and Type Method Description GroovyClassDoc[]classes()GroovyClassDocclassNamed(GroovyClassDoc groovyClassDoc, java.lang.String name)GroovyClassDocclassNamedExact(java.lang.String name)java.lang.Stringdescription()java.util.Map<java.lang.String,GroovyClassDoc>getResolvedClasses()java.util.Map<java.lang.String,GroovyClassDoc>getVisibleClasses(java.util.List importedClassesAndPackages)java.lang.String[][]options()GroovyPackageDocpackageNamed(java.lang.String packageName)voidprintError(java.lang.String arg0)voidprintNotice(java.lang.String arg0)voidprintWarning(java.lang.String arg0)voidput(java.lang.String packageName, GroovyPackageDoc packageDoc)voidputAllClasses(java.util.Map<java.lang.String,GroovyClassDoc> classes)voidresolve()voidsetDescription(java.lang.String description)GroovyClassDoc[]specifiedClasses()GroovyPackageDoc[]specifiedPackages()java.lang.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, toStringMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.ComparablecompareToMethods 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 Details- 
SimpleGroovyRootDocpublic SimpleGroovyRootDoc(java.lang.String name)
 
- 
- 
Method Details- 
classNamed- Specified by:
- classNamedin interface- GroovyRootDoc
 
- 
classNamedExact
- 
setDescriptionpublic void setDescription(java.lang.String description)
- 
descriptionpublic java.lang.String description()
- 
summarypublic java.lang.String summary()
- 
classes- Specified by:
- classesin interface- GroovyRootDoc
 
- 
optionspublic java.lang.String[][] options()- Specified by:
- optionsin interface- GroovyRootDoc
 
- 
packageNamed- Specified by:
- packageNamedin interface- GroovyRootDoc
 
- 
putAllClasses
- 
put
- 
specifiedClasses- Specified by:
- specifiedClassesin interface- GroovyRootDoc
 
- 
specifiedPackages- Specified by:
- specifiedPackagesin interface- GroovyRootDoc
 
- 
getVisibleClassespublic java.util.Map<java.lang.String,GroovyClassDoc> getVisibleClasses(java.util.List importedClassesAndPackages)- Specified by:
- getVisibleClassesin interface- GroovyRootDoc
 
- 
getResolvedClasses- Specified by:
- getResolvedClassesin interface- GroovyRootDoc
 
- 
printErrorpublic void printError(java.lang.String arg0)- Specified by:
- printErrorin interface- GroovyDocErrorReporter
 
- 
printNoticepublic void printNotice(java.lang.String arg0)- Specified by:
- printNoticein interface- GroovyDocErrorReporter
 
- 
printWarningpublic void printWarning(java.lang.String arg0)- Specified by:
- printWarningin interface- GroovyDocErrorReporter
 
- 
resolvepublic void resolve()
 
-