public class SimpleGroovyDoc extends java.lang.Object implements GroovyDoc, org.codehaus.groovy.antlr.parser.GroovyTokenTypes
ABSTRACT, ANNOTATION, ANNOTATION_ARRAY_INIT, ANNOTATION_DEF, ANNOTATION_FIELD_DEF, ANNOTATION_MEMBER_VALUE_PAIR, ANNOTATIONS, ARRAY_DECLARATOR, ASSIGN, AT, BAND, BAND_ASSIGN, BIG_SUFFIX, BLOCK, BNOT, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, CASE_GROUP, CLASS_DEF, CLOSABLE_BLOCK, CLOSABLE_BLOCK_OP, CLOSURE_LIST, COLON, COMMA, COMPARE_TO, CTOR_CALL, CTOR_IDENT, DEC, DIGIT, DIGITS_WITH_UNDERSCORE, DIGITS_WITH_UNDERSCORE_OPT, DIV, DIV_ASSIGN, DOLLAR, DOLLAR_REGEXP_CTOR_END, DOLLAR_REGEXP_LITERAL, DOLLAR_REGEXP_SYMBOL, DOT, DYNAMIC_MEMBER, ELIST, ELVIS_OPERATOR, EMPTY_STAT, ENUM_CONSTANT_DEF, ENUM_DEF, EOF, EQUAL, ESC, ESCAPED_DOLLAR, ESCAPED_SLASH, EXPONENT, EXPR, EXTENDS_CLAUSE, FINAL, FLOAT_SUFFIX, FOR_CONDITION, FOR_EACH_CLAUSE, FOR_IN_ITERABLE, FOR_INIT, FOR_ITERATOR, GE, GT, HEX_DIGIT, IDENT, IDENTICAL, IMPLEMENTS_CLAUSE, IMPLICIT_PARAMETERS, IMPORT, INC, INDEX_OP, INSTANCE_INIT, INTERFACE_DEF, LABELED_ARG, LABELED_STAT, LAND, LBRACK, LCURLY, LE, LETTER, LIST_CONSTRUCTOR, LITERAL_as, LITERAL_assert, LITERAL_boolean, LITERAL_break, LITERAL_byte, LITERAL_case, LITERAL_catch, LITERAL_char, LITERAL_class, LITERAL_continue, LITERAL_def, LITERAL_default, LITERAL_double, LITERAL_else, LITERAL_enum, LITERAL_extends, LITERAL_false, LITERAL_finally, LITERAL_float, LITERAL_for, LITERAL_if, LITERAL_implements, LITERAL_import, LITERAL_in, LITERAL_instanceof, LITERAL_int, LITERAL_interface, LITERAL_long, LITERAL_native, LITERAL_new, LITERAL_null, LITERAL_package, LITERAL_private, LITERAL_protected, LITERAL_public, LITERAL_return, LITERAL_short, LITERAL_static, LITERAL_super, LITERAL_switch, LITERAL_synchronized, LITERAL_this, LITERAL_threadsafe, LITERAL_throw, LITERAL_throws, LITERAL_trait, LITERAL_transient, LITERAL_true, LITERAL_try, LITERAL_void, LITERAL_volatile, LITERAL_while, LNOT, LOR, LPAREN, LT, MAP_CONSTRUCTOR, MEMBER_POINTER, METHOD_CALL, METHOD_DEF, MINUS, MINUS_ASSIGN, ML_COMMENT, MOD, MOD_ASSIGN, MODIFIERS, MULTICATCH, MULTICATCH_TYPES, NLS, NOT_EQUAL, NOT_IDENTICAL, NULL_TREE_LOOKAHEAD, NUM_BIG_DECIMAL, NUM_BIG_INT, NUM_DOUBLE, NUM_FLOAT, NUM_INT, NUM_LONG, OBJBLOCK, ONE_NL, OPTIONAL_DOT, PACKAGE_DEF, PARAMETER_DEF, PARAMETERS, PLUS, PLUS_ASSIGN, POST_DEC, POST_INC, QUESTION, RANGE_EXCLUSIVE, RANGE_INCLUSIVE, RBRACK, RCURLY, REGEX_FIND, REGEX_MATCH, REGEXP_CTOR_END, REGEXP_LITERAL, REGEXP_SYMBOL, RPAREN, SELECT_SLOT, SEMI, SH_COMMENT, SL, SL_ASSIGN, SL_COMMENT, SLIST, SPREAD_ARG, SPREAD_DOT, SPREAD_MAP_ARG, SR, SR_ASSIGN, STAR, STAR_ASSIGN, STAR_STAR, STAR_STAR_ASSIGN, STATIC_IMPORT, STATIC_INIT, STRICTFP, STRING_CH, STRING_CONSTRUCTOR, STRING_CTOR_END, STRING_CTOR_MIDDLE, STRING_CTOR_START, STRING_LITERAL, STRING_NL, SUPER_CTOR_CALL, TRAIT_DEF, TRIPLE_DOT, TYPE, TYPE_ARGUMENT, TYPE_ARGUMENTS, TYPE_LOWER_BOUNDS, TYPE_PARAMETER, TYPE_PARAMETERS, TYPE_UPPER_BOUNDS, TYPECAST, UNARY_MINUS, UNARY_PLUS, UNUSED_CONST, UNUSED_DO, UNUSED_GOTO, VARIABLE_DEF, VARIABLE_PARAMETER_DEF, VOCAB, WILDCARD_TYPE, WS| Constructor and Description |
|---|
SimpleGroovyDoc(java.lang.String name) |
| Modifier and Type | Method and Description |
|---|---|
static java.lang.String |
calculateFirstSentence(java.lang.String raw) |
java.lang.String |
commentText() |
int |
compareTo(java.lang.Object that) |
java.lang.String |
firstSentenceCommentText() |
java.lang.String |
getRawCommentText() |
java.lang.String |
getTypeDescription() |
java.lang.String |
getTypeSourceDescription() |
boolean |
isAnnotationType() |
boolean |
isAnnotationTypeElement() |
boolean |
isClass() |
boolean |
isConstructor() |
boolean |
isDeprecated() |
boolean |
isEnum() |
boolean |
isEnumConstant() |
boolean |
isError() |
boolean |
isException() |
boolean |
isField() |
boolean |
isIncluded() |
boolean |
isInterface() |
boolean |
isMethod() |
boolean |
isOrdinaryClass() |
boolean |
isScript() |
boolean |
isTrait() |
java.lang.String |
name() |
protected void |
setCommentText(java.lang.String commentText) |
void |
setDeprecated(boolean deprecated) |
protected void |
setFirstSentenceCommentText(java.lang.String firstSentenceCommentText) |
void |
setRawCommentText(java.lang.String rawCommentText) |
void |
setScript(boolean script) |
void |
setTokenType(int t) |
GroovyTag[] |
tags() |
int |
tokenType() |
java.lang.String |
toString() |
public java.lang.String toString()
toString in class java.lang.Objectprotected void setCommentText(java.lang.String commentText)
protected void setFirstSentenceCommentText(java.lang.String firstSentenceCommentText)
public java.lang.String commentText()
commentText in interface GroovyDocpublic java.lang.String firstSentenceCommentText()
firstSentenceCommentText in interface GroovyDocpublic java.lang.String getRawCommentText()
getRawCommentText in interface GroovyDocpublic void setRawCommentText(java.lang.String rawCommentText)
setRawCommentText in interface GroovyDocpublic void setScript(boolean script)
public static java.lang.String calculateFirstSentence(java.lang.String raw)
public boolean isScript()
public boolean isTrait()
public boolean isInterface()
isInterface in interface GroovyDocpublic boolean isAnnotationType()
isAnnotationType in interface GroovyDocpublic java.lang.String getTypeDescription()
public java.lang.String getTypeSourceDescription()
public void setTokenType(int t)
public int tokenType()
public int compareTo(java.lang.Object that)
compareTo in interface java.lang.Comparablepublic boolean isAnnotationTypeElement()
isAnnotationTypeElement in interface GroovyDocpublic boolean isConstructor()
isConstructor in interface GroovyDocpublic boolean isEnumConstant()
isEnumConstant in interface GroovyDocpublic boolean isDeprecated()
isDeprecated in interface GroovyDocpublic boolean isException()
isException in interface GroovyDocpublic boolean isIncluded()
isIncluded in interface GroovyDocpublic boolean isOrdinaryClass()
isOrdinaryClass in interface GroovyDocpublic GroovyTag[] tags()
public void setDeprecated(boolean deprecated)