Class SimpleGroovyDoc
java.lang.Object
org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
- All Implemented Interfaces:
Comparable<GroovyDoc>,GroovyDoc
- Direct Known Subclasses:
SimpleGroovyPackageDoc,SimpleGroovyProgramElementDoc,SimpleGroovyRootDoc
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final int -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic StringintbooleanbooleanbooleanisClass()booleanbooleanbooleanisEnum()booleanbooleanisError()booleanbooleanisField()booleanbooleanbooleanisMethod()booleanbooleanisRecord()booleanisScript()booleanisTrait()name()protected voidsetCommentText(String commentText) voidsetDeprecated(boolean deprecated) protected voidsetFirstSentenceCommentText(String firstSentenceCommentText) voidsetRawCommentText(String rawCommentText) voidsetScript(boolean script) voidsetTokenType(int t) tags()inttoString()
-
Field Details
-
CLASS_DEF
public static final int CLASS_DEF- See Also:
-
TRAIT_DEF
public static final int TRAIT_DEF- See Also:
-
INTERFACE_DEF
public static final int INTERFACE_DEF- See Also:
-
RECORD_DEF
public static final int RECORD_DEF- See Also:
-
ANNOTATION_DEF
public static final int ANNOTATION_DEF- See Also:
-
ENUM_DEF
public static final int ENUM_DEF- See Also:
-
-
Constructor Details
-
SimpleGroovyDoc
-
-
Method Details
-
name
-
toString
-
setCommentText
-
setFirstSentenceCommentText
-
commentText
- Specified by:
commentTextin interfaceGroovyDoc
-
firstSentenceCommentText
- Specified by:
firstSentenceCommentTextin interfaceGroovyDoc
-
getRawCommentText
- Specified by:
getRawCommentTextin interfaceGroovyDoc
-
setRawCommentText
- Specified by:
setRawCommentTextin interfaceGroovyDoc
-
setScript
public void setScript(boolean script) -
calculateFirstSentence
-
isClass
public boolean isClass() -
isScript
public boolean isScript() -
isTrait
public boolean isTrait() -
isInterface
public boolean isInterface()- Specified by:
isInterfacein interfaceGroovyDoc
-
isAnnotationType
public boolean isAnnotationType()- Specified by:
isAnnotationTypein interfaceGroovyDoc
-
isEnum
public boolean isEnum() -
isRecord
public boolean isRecord() -
getTypeDescription
-
getTypeSourceDescription
-
setTokenType
public void setTokenType(int t) -
tokenType
public int tokenType() -
compareTo
- Specified by:
compareToin interfaceComparable<GroovyDoc>
-
isAnnotationTypeElement
public boolean isAnnotationTypeElement()- Specified by:
isAnnotationTypeElementin interfaceGroovyDoc
-
isConstructor
public boolean isConstructor()- Specified by:
isConstructorin interfaceGroovyDoc
-
isEnumConstant
public boolean isEnumConstant()- Specified by:
isEnumConstantin interfaceGroovyDoc
-
isDeprecated
public boolean isDeprecated()- Specified by:
isDeprecatedin interfaceGroovyDoc
-
isError
public boolean isError() -
isException
public boolean isException()- Specified by:
isExceptionin interfaceGroovyDoc
-
isField
public boolean isField() -
isIncluded
public boolean isIncluded()- Specified by:
isIncludedin interfaceGroovyDoc
-
isMethod
public boolean isMethod() -
isOrdinaryClass
public boolean isOrdinaryClass()- Specified by:
isOrdinaryClassin interfaceGroovyDoc
-
tags
-
setDeprecated
public void setDeprecated(boolean deprecated)
-