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 Summary
Fields inherited from class org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
ANNOTATION_DEF, CLASS_DEF, ENUM_DEF, INTERFACE_DEF, RECORD_DEF, TRAIT_DEF -
Constructor Summary
Constructors -
Method Summary
Modifier 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.SimpleGroovyDoc
calculateFirstSentence, 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.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, isRecord, name, setRawCommentText
-
Constructor Details
-
SimpleGroovyPackageDoc
-
-
Method Details
-
allClasses
Description copied from interface:GroovyPackageDocAll included classes and interfaces in this package.- Specified by:
allClassesin interfaceGroovyPackageDoc- Returns:
- array of classes and interfaces found or empty array if none found
-
setDescription
-
setSummary
-
putAll
-
nameWithDots
- Specified by:
nameWithDotsin interfaceGroovyPackageDoc
-
allClasses
Description copied from interface:GroovyPackageDocAll classes and interfaces in this package optionally limited to just the included ones.- Specified by:
allClassesin interfaceGroovyPackageDoc- 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
-
enums
Description copied from interface:GroovyPackageDocIncluded enum types in this package.- Specified by:
enumsin interfaceGroovyPackageDoc- Returns:
- array of enum types found or empty array if none found
-
errors
Description copied from interface:GroovyPackageDocIncluded errors in this package.- Specified by:
errorsin interfaceGroovyPackageDoc- Returns:
- array of errors found or empty array if none found
-
exceptions
Description copied from interface:GroovyPackageDocIncluded exceptions in this package.- Specified by:
exceptionsin interfaceGroovyPackageDoc- Returns:
- array of exceptions found or empty array if none found
-
findClass
Description copied from interface:GroovyPackageDocFind a class or interface within this package.- Specified by:
findClassin interfaceGroovyPackageDoc- Parameters:
arg0- the name of the class to find- Returns:
- ClassDoc of found class or interface, or null if not found
-
interfaces
Description copied from interface:GroovyPackageDocIncluded interfaces in this package.- Specified by:
interfacesin interfaceGroovyPackageDoc- Returns:
- array of interfaces found or empty array if none found
-
ordinaryClasses
Description copied from interface:GroovyPackageDocIncluded ordinary classes in this package.- Specified by:
ordinaryClassesin interfaceGroovyPackageDoc- Returns:
- array of ordinary classes (non-interface, non-enum, non-throwable classes) found or empty array if none found
-
description
Description copied from interface:GroovyPackageDocDescription of the package.- Specified by:
descriptionin interfaceGroovyPackageDoc- Returns:
- the description
-
summary
Description copied from interface:GroovyPackageDocThe one-sentence summary for the package derived from the beginning of the description.- Specified by:
summaryin interfaceGroovyPackageDoc- Returns:
- the summary
-
getRelativeRootPath
- Specified by:
getRelativeRootPathin interfaceGroovyPackageDoc
-