Class SimpleGroovyPackageDoc
java.lang.Object
org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
org.codehaus.groovy.tools.groovydoc.SimpleGroovyPackageDoc
- All Implemented Interfaces:
- Comparable<GroovyDoc>,- GroovyDoc,- GroovyPackageDoc
- 
Field SummaryFields inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyDocANNOTATION_DEF, CLASS_DEF, ENUM_DEF, INTERFACE_DEF, RECORD_DEF, TRAIT_DEF
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionAll included classes and interfaces in this package.allClasses(boolean arg0) 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.voidputAll(Map<String, GroovyClassDoc> classes) voidsetDescription(String description) voidsetSummary(String summary) summary()The one-sentence summary for the package derived from the beginning of the description.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, isRecord, 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, isRecord, name, setRawCommentText
- 
Constructor Details- 
SimpleGroovyPackageDoc
 
- 
- 
Method Details- 
allClassesDescription copied from interface:GroovyPackageDocAll included classes and interfaces in this package.- Specified by:
- allClassesin interface- GroovyPackageDoc
- Returns:
- array of classes and interfaces found or empty array if none found
 
- 
setDescription
- 
setSummary
- 
putAll
- 
nameWithDots- Specified by:
- nameWithDotsin interface- GroovyPackageDoc
 
- 
allClassesDescription copied from interface:GroovyPackageDocAll classes and interfaces in this package optionally limited to just the included ones.- Specified by:
- allClassesin interface- GroovyPackageDoc
- Parameters:
- arg0- 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
 
- 
enumsDescription copied from interface:GroovyPackageDocIncluded enum types in this package.- Specified by:
- enumsin interface- GroovyPackageDoc
- Returns:
- array of enum types found or empty array if none found
 
- 
errorsDescription copied from interface:GroovyPackageDocIncluded errors in this package.- Specified by:
- errorsin interface- GroovyPackageDoc
- Returns:
- array of errors found or empty array if none found
 
- 
exceptionsDescription copied from interface:GroovyPackageDocIncluded exceptions in this package.- Specified by:
- exceptionsin interface- GroovyPackageDoc
- Returns:
- array of exceptions found or empty array if none found
 
- 
findClassDescription copied from interface:GroovyPackageDocFind a class or interface within this package.- Specified by:
- findClassin interface- GroovyPackageDoc
- Parameters:
- arg0- the name of the class to find
- Returns:
- ClassDoc of found class or interface, or null if not found
 
- 
interfacesDescription copied from interface:GroovyPackageDocIncluded interfaces in this package.- Specified by:
- interfacesin interface- GroovyPackageDoc
- Returns:
- array of interfaces found or empty array if none found
 
- 
ordinaryClassesDescription copied from interface:GroovyPackageDocIncluded ordinary classes in this package.- Specified by:
- ordinaryClassesin interface- GroovyPackageDoc
- Returns:
- array of ordinary classes (non-interface, non-enum, non-throwable classes) found or empty array if none found
 
- 
descriptionDescription copied from interface:GroovyPackageDocDescription of the package.- Specified by:
- descriptionin interface- GroovyPackageDoc
- Returns:
- the description
 
- 
summaryDescription copied from interface:GroovyPackageDocThe one-sentence summary for the package derived from the beginning of the description.- Specified by:
- summaryin interface- GroovyPackageDoc
- Returns:
- the summary
 
- 
getRelativeRootPath- Specified by:
- getRelativeRootPathin interface- GroovyPackageDoc
 
 
-