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 Summary
Fields inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
ANNOTATION_DEF, CLASS_DEF, ENUM_DEF, INTERFACE_DEF, TRAIT_DEF -
Constructor Summary
Constructors Constructor Description SimpleGroovyRootDoc(java.lang.String name) -
Method Summary
Modifier 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.SimpleGroovyDoc
calculateFirstSentence, 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.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface org.codehaus.groovy.groovydoc.GroovyDoc
commentText, firstSentenceCommentText, getRawCommentText, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, setRawCommentText
-
Constructor Details
-
SimpleGroovyRootDoc
public SimpleGroovyRootDoc(java.lang.String name)
-
-
Method Details
-
classNamed
- Specified by:
classNamedin interfaceGroovyRootDoc
-
classNamedExact
-
setDescription
public void setDescription(java.lang.String description) -
description
public java.lang.String description() -
summary
public java.lang.String summary() -
classes
- Specified by:
classesin interfaceGroovyRootDoc
-
options
public java.lang.String[][] options()- Specified by:
optionsin interfaceGroovyRootDoc
-
packageNamed
- Specified by:
packageNamedin interfaceGroovyRootDoc
-
putAllClasses
-
put
-
specifiedClasses
- Specified by:
specifiedClassesin interfaceGroovyRootDoc
-
specifiedPackages
- Specified by:
specifiedPackagesin interfaceGroovyRootDoc
-
getVisibleClasses
public java.util.Map<java.lang.String,GroovyClassDoc> getVisibleClasses(java.util.List importedClassesAndPackages)- Specified by:
getVisibleClassesin interfaceGroovyRootDoc
-
getResolvedClasses
- Specified by:
getResolvedClassesin interfaceGroovyRootDoc
-
printError
public void printError(java.lang.String arg0)- Specified by:
printErrorin interfaceGroovyDocErrorReporter
-
printNotice
public void printNotice(java.lang.String arg0)- Specified by:
printNoticein interfaceGroovyDocErrorReporter
-
printWarning
public void printWarning(java.lang.String arg0)- Specified by:
printWarningin interfaceGroovyDocErrorReporter
-
resolve
public void resolve()
-