public interface GroovyPackageDoc extends GroovyDoc
Modifier and Type | Method and Description |
---|---|
GroovyClassDoc[] |
allClasses()
All included classes and interfaces in this package.
|
GroovyClassDoc[] |
allClasses(boolean filter)
All classes and interfaces in this package optionally
limited to just the included ones.
|
String |
description()
Description of the package.
|
GroovyClassDoc[] |
enums()
Included enum types in this package.
|
GroovyClassDoc[] |
errors()
Included errors in this package.
|
GroovyClassDoc[] |
exceptions()
Included exceptions in this package.
|
GroovyClassDoc |
findClass(String className)
Find a class or interface within this package.
|
String |
getRelativeRootPath() |
GroovyClassDoc[] |
interfaces()
Included interfaces in this package.
|
String |
nameWithDots() |
GroovyClassDoc[] |
ordinaryClasses()
Included ordinary classes in this package.
|
String |
summary()
The one-sentence summary for the package derived from the beginning of the description.
|
commentText, firstSentenceCommentText, getRawCommentText, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, setRawCommentText
compareTo
GroovyClassDoc[] allClasses()
GroovyClassDoc[] allClasses(boolean filter)
filter
- Specifying true filters according to the specified access modifier option.
Specifying false includes all classes and interfaces regardless of access modifier option.GroovyClassDoc[] enums()
GroovyClassDoc[] errors()
GroovyClassDoc[] exceptions()
GroovyClassDoc findClass(String className)
className
- the name of the class to findGroovyClassDoc[] interfaces()
GroovyClassDoc[] ordinaryClasses()
String summary()
String description()
String nameWithDots()
String getRelativeRootPath()