SimpleGroovyDoc (Groovy 4.0.24)

org.codehaus.groovy.tools.groovydoc.SimpleGroovyDoc

All Implemented Interfaces and Traits:: GroovyDoc

public class SimpleGroovyDoc
extends Object
implements GroovyDoc

Field Summary

Fields
Modifiers	Name	Description
`static int`	`ANNOTATION_DEF`
`static int`	`CLASS_DEF`
`static int`	`ENUM_DEF`
`static int`	`INTERFACE_DEF`
`static int`	`RECORD_DEF`
`static int`	`TRAIT_DEF`

Constructor Summary

Constructors
Constructor and description
`SimpleGroovyDoc(String name)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public static String`	`calculateFirstSentence(String raw)`
	`public String`	`commentText()`
	`public int`	`compareTo(GroovyDoc that)`
	`public String`	`firstSentenceCommentText()`
	`public String`	`getRawCommentText()`
	`public String`	`getTypeDescription()`
	`public String`	`getTypeSourceDescription()`
	`public boolean`	`isAnnotationType()`
	`public boolean`	`isAnnotationTypeElement()`
	`public boolean`	`isClass()`
	`public boolean`	`isConstructor()`
	`public boolean`	`isDeprecated()`
	`public boolean`	`isEnum()`
	`public boolean`	`isEnumConstant()`
	`public boolean`	`isError()`
	`public boolean`	`isException()`
	`public boolean`	`isField()`
	`public boolean`	`isIncluded()`
	`public boolean`	`isInterface()`
	`public boolean`	`isMethod()`
	`public boolean`	`isOrdinaryClass()`
	`public boolean`	`isRecord()`
	`public boolean`	`isScript()`
	`public boolean`	`isTrait()`
	`public String`	`name()`
	`protected void`	`setCommentText(String commentText)`
	`public void`	`setDeprecated(boolean deprecated)`
	`protected void`	`setFirstSentenceCommentText(String firstSentenceCommentText)`
	`public void`	`setRawCommentText(String rawCommentText)`
	`public void`	`setScript(boolean script)`
	`public void`	`setTokenType(int t)`
	`public GroovyTag[]`	`tags()`
	`public String`	`toString()`
	`public int`	`tokenType()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - public static final int ANNOTATION_DEF
  - public static final int CLASS_DEF
  - public static final int ENUM_DEF
  - public static final int INTERFACE_DEF
  - public static final int RECORD_DEF
  - public static final int TRAIT_DEF
- Constructor Detail
  - public SimpleGroovyDoc(String name)
- Method Detail
  - public static String calculateFirstSentence(String raw)
  - @Override
    public String commentText()
  - @Override
    public int compareTo(GroovyDoc that)
  - @Override
    public String firstSentenceCommentText()
  - @Override
    public String getRawCommentText()
  - public String getTypeDescription()
  - public String getTypeSourceDescription()
  - @Override
    public boolean isAnnotationType()
  - @Override
    public boolean isAnnotationTypeElement()
  - @Override
    public boolean isClass()
  - @Override
    public boolean isConstructor()
  - @Override
    public boolean isDeprecated()
  - @Override
    public boolean isEnum()
  - @Override
    public boolean isEnumConstant()
  - @Override
    public boolean isError()
  - @Override
    public boolean isException()
  - @Override
    public boolean isField()
  - @Override
    public boolean isIncluded()
  - @Override
    public boolean isInterface()
  - @Override
    public boolean isMethod()
  - @Override
    public boolean isOrdinaryClass()
  - @Override
    public boolean isRecord()
  - public boolean isScript()
  - public boolean isTrait()
  - @Override
    public String name()
  - protected void setCommentText(String commentText)
  - public void setDeprecated(boolean deprecated)
  - protected void setFirstSentenceCommentText(String firstSentenceCommentText)
  - @Override
    public void setRawCommentText(String rawCommentText)
  - public void setScript(boolean script)
  - public void setTokenType(int t)
  - public GroovyTag[] tags()
  - @Override
    public String toString()
  - public int tokenType()

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class SimpleGroovyDoc

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final int ANNOTATION_DEF

public static final int CLASS_DEF

public static final int ENUM_DEF

public static final int INTERFACE_DEF

public static final int RECORD_DEF

public static final int TRAIT_DEF

Constructor Detail

public SimpleGroovyDoc(String name)

Method Detail

public static String calculateFirstSentence(String raw)

@Overridepublic String commentText()

@Overridepublic int compareTo(GroovyDoc that)

@Overridepublic String firstSentenceCommentText()

@Overridepublic String getRawCommentText()

public String getTypeDescription()

public String getTypeSourceDescription()

@Overridepublic boolean isAnnotationType()

@Overridepublic boolean isAnnotationTypeElement()

@Overridepublic boolean isClass()

@Overridepublic boolean isConstructor()

@Overridepublic boolean isDeprecated()

@Overridepublic boolean isEnum()

@Overridepublic boolean isEnumConstant()

@Overridepublic boolean isError()

@Overridepublic boolean isException()

@Overridepublic boolean isField()

@Overridepublic boolean isIncluded()

@Overridepublic boolean isInterface()

@Overridepublic boolean isMethod()

@Overridepublic boolean isOrdinaryClass()

@Overridepublic boolean isRecord()

public boolean isScript()

public boolean isTrait()

@Overridepublic String name()

protected void setCommentText(String commentText)

public void setDeprecated(boolean deprecated)

protected void setFirstSentenceCommentText(String firstSentenceCommentText)

@Overridepublic void setRawCommentText(String rawCommentText)

public void setScript(boolean script)

public void setTokenType(int t)

public GroovyTag[] tags()

@Overridepublic String toString()

public int tokenType()

@Override
public String commentText()

@Override
public int compareTo(GroovyDoc that)

@Override
public String firstSentenceCommentText()

@Override
public String getRawCommentText()

@Override
public boolean isAnnotationType()

@Override
public boolean isAnnotationTypeElement()

@Override
public boolean isClass()

@Override
public boolean isConstructor()

@Override
public boolean isDeprecated()

@Override
public boolean isEnum()

@Override
public boolean isEnumConstant()

@Override
public boolean isError()

@Override
public boolean isException()

@Override
public boolean isField()

@Override
public boolean isIncluded()

@Override
public boolean isInterface()

@Override
public boolean isMethod()

@Override
public boolean isOrdinaryClass()

@Override
public boolean isRecord()

@Override
public String name()

@Override
public void setRawCommentText(String rawCommentText)

@Override
public String toString()