org.codehaus.groovy.tools.groovydoc
Class SimpleGroovyDoc
java.lang.Object
org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc
- All Implemented Interfaces:
- java.lang.Comparable, GroovyDoc
- Direct Known Subclasses:
- SimpleGroovyPackageDoc, SimpleGroovyProgramElementDoc, SimpleGroovyRootDoc
public class SimpleGroovyDoc
- extends java.lang.Object
- implements GroovyDoc
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
SimpleGroovyDoc
public SimpleGroovyDoc(java.lang.String name,
java.util.List links)
SimpleGroovyDoc
public SimpleGroovyDoc(java.lang.String name)
name
public java.lang.String name()
- Specified by:
name
in interface GroovyDoc
toString
public java.lang.String toString()
- Overrides:
toString
in class java.lang.Object
commentText
public java.lang.String commentText()
- Specified by:
commentText
in interface GroovyDoc
getRawCommentText
public java.lang.String getRawCommentText()
- Specified by:
getRawCommentText
in interface GroovyDoc
firstSentenceCommentText
public java.lang.String firstSentenceCommentText()
- Specified by:
firstSentenceCommentText
in interface GroovyDoc
setRawCommentText
public void setRawCommentText(java.lang.String rawCommentText)
- Specified by:
setRawCommentText
in interface GroovyDoc
replaceAllTags
public java.lang.String replaceAllTags(java.lang.String self,
java.lang.String regex,
java.lang.String s1,
java.lang.String s2)
getDocUrl
public java.lang.String getDocUrl(java.lang.String type)
isClass
public boolean isClass()
- Specified by:
isClass
in interface GroovyDoc
isInterface
public boolean isInterface()
- Specified by:
isInterface
in interface GroovyDoc
setAsInterfaceDefinition
public void setAsInterfaceDefinition()
compareTo
public int compareTo(java.lang.Object that)
- Specified by:
compareTo
in interface java.lang.Comparable
isAnnotationType
public boolean isAnnotationType()
- Specified by:
isAnnotationType
in interface GroovyDoc
isAnnotationTypeElement
public boolean isAnnotationTypeElement()
- Specified by:
isAnnotationTypeElement
in interface GroovyDoc
isConstructor
public boolean isConstructor()
- Specified by:
isConstructor
in interface GroovyDoc
isEnum
public boolean isEnum()
- Specified by:
isEnum
in interface GroovyDoc
isEnumConstant
public boolean isEnumConstant()
- Specified by:
isEnumConstant
in interface GroovyDoc
isError
public boolean isError()
- Specified by:
isError
in interface GroovyDoc
isException
public boolean isException()
- Specified by:
isException
in interface GroovyDoc
isField
public boolean isField()
- Specified by:
isField
in interface GroovyDoc
isIncluded
public boolean isIncluded()
- Specified by:
isIncluded
in interface GroovyDoc
isMethod
public boolean isMethod()
- Specified by:
isMethod
in interface GroovyDoc
isOrdinaryClass
public boolean isOrdinaryClass()
- Specified by:
isOrdinaryClass
in interface GroovyDoc