Package org.codehaus.groovy.groovydoc
Interface GroovyPackageDoc
- All Superinterfaces:
- Comparable<GroovyDoc>,- GroovyDoc
- All Known Implementing Classes:
- SimpleGroovyPackageDoc
- 
Method SummaryModifier and TypeMethodDescriptionAll included classes and interfaces in this package.allClasses(boolean filter) All classes and interfaces in this package optionally limited to just the included ones.Description of the package.enums()Included enum types in this package.errors()Included errors in this package.Included exceptions in this package.Find a class or interface within this package.Included interfaces in this package.Included ordinary classes in this package.summary()The one-sentence summary for the package derived from the beginning of the description.Methods 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, isRecord, name, setRawCommentText
- 
Method Details- 
allClassesGroovyClassDoc[] allClasses()All included classes and interfaces in this package.- Returns:
- array of classes and interfaces found or empty array if none found
 
- 
allClassesAll classes and interfaces in this package optionally limited to just the included ones.- Parameters:
- filter- Specifying true filters according to the specified access modifier option. Specifying false includes all classes and interfaces regardless of access modifier option.
- Returns:
- array of classes and interfaces found or empty array if none found
 
- 
enumsGroovyClassDoc[] enums()Included enum types in this package.- Returns:
- array of enum types found or empty array if none found
 
- 
errorsGroovyClassDoc[] errors()Included errors in this package.- Returns:
- array of errors found or empty array if none found
 
- 
exceptionsGroovyClassDoc[] exceptions()Included exceptions in this package.- Returns:
- array of exceptions found or empty array if none found
 
- 
findClassFind a class or interface within this package.- Parameters:
- className- the name of the class to find
- Returns:
- ClassDoc of found class or interface, or null if not found
 
- 
interfacesGroovyClassDoc[] interfaces()Included interfaces in this package.- Returns:
- array of interfaces found or empty array if none found
 
- 
ordinaryClassesGroovyClassDoc[] ordinaryClasses()Included ordinary classes in this package.- Returns:
- array of ordinary classes (non-interface, non-enum, non-throwable classes) found or empty array if none found
 
- 
summaryString summary()The one-sentence summary for the package derived from the beginning of the description.- Returns:
- the summary
 
- 
descriptionString description()Description of the package.- Returns:
- the description
 
- 
nameWithDotsString nameWithDots()
- 
getRelativeRootPathString getRelativeRootPath()
 
-