Package org.codehaus.groovy.groovydoc
Interface GroovyDoc
-
- All Superinterfaces:
java.lang.Comparable
- All Known Subinterfaces:
GroovyClassDoc,GroovyConstructorDoc,GroovyExecutableMemberDoc,GroovyFieldDoc,GroovyMemberDoc,GroovyMethodDoc,GroovyPackageDoc,GroovyProgramElementDoc,GroovyRootDoc
- All Known Implementing Classes:
ArrayClassDocWrapper,ExternalGroovyClassDoc,SimpleGroovyAbstractableElementDoc,SimpleGroovyClassDoc,SimpleGroovyConstructorDoc,SimpleGroovyDoc,SimpleGroovyExecutableMemberDoc,SimpleGroovyFieldDoc,SimpleGroovyMemberDoc,SimpleGroovyMethodDoc,SimpleGroovyPackageDoc,SimpleGroovyProgramElementDoc,SimpleGroovyRootDoc
public interface GroovyDoc extends java.lang.Comparable
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringcommentText()java.lang.StringfirstSentenceCommentText()java.lang.StringgetRawCommentText()booleanisAnnotationType()booleanisAnnotationTypeElement()booleanisClass()booleanisConstructor()booleanisDeprecated()booleanisEnum()booleanisEnumConstant()booleanisError()booleanisException()booleanisField()booleanisIncluded()booleanisInterface()booleanisMethod()booleanisOrdinaryClass()java.lang.Stringname()voidsetRawCommentText(java.lang.String arg0)
-
-
-
Method Detail
-
commentText
java.lang.String commentText()
-
getRawCommentText
java.lang.String getRawCommentText()
-
isAnnotationType
boolean isAnnotationType()
-
isAnnotationTypeElement
boolean isAnnotationTypeElement()
-
isClass
boolean isClass()
-
isConstructor
boolean isConstructor()
-
isDeprecated
boolean isDeprecated()
-
isEnum
boolean isEnum()
-
isEnumConstant
boolean isEnumConstant()
-
isError
boolean isError()
-
isException
boolean isException()
-
isField
boolean isField()
-
isIncluded
boolean isIncluded()
-
isInterface
boolean isInterface()
-
isMethod
boolean isMethod()
-
isOrdinaryClass
boolean isOrdinaryClass()
-
name
java.lang.String name()
-
setRawCommentText
void setRawCommentText(java.lang.String arg0)
-
firstSentenceCommentText
java.lang.String firstSentenceCommentText()
-
-