Field Summary

Fields 

Modifiers	Name	Description
static Pattern	CODE_REGEX
static String	DOCROOT_PATTERN
static String	DOCROOT_PATTERN2
static Pattern	LINK_REGEX
static Pattern	LITERAL_REGEX
static Pattern	NAME_ARGS_REGEX
static Pattern	REF_LABEL_REGEX
static Pattern	SPLIT_ARGS_REGEX
static Pattern	TAG_REGEX

Inherited fields 

Fields inherited from class	Fields
class SimpleGroovyDoc	ANNOTATION_DEF, CLASS_DEF, ENUM_DEF, INTERFACE_DEF, TRAIT_DEF

Constructor Summary

Constructors 

Constructor and description
SimpleGroovyClassDoc (List<String> importedClassesAndPackages, Map<String, String> aliases, String name, List<LinkArgument> links)
SimpleGroovyClassDoc (List<String> importedClassesAndPackages, Map<String, String> aliases, String name)
SimpleGroovyClassDoc (List<String> importedClassesAndPackages, String name)

Methods Summary

Methods 

Type Params	Return Type	Name and description
	boolean	add(GroovyConstructorDoc constructor)
	boolean	add(GroovyFieldDoc field)
	boolean	add(GroovyMethodDoc method)
	boolean	addEnumConstant(GroovyFieldDoc field)
	void	addInterfaceName(String className)
	boolean	addNested(GroovyClassDoc nestedClass)
	boolean	addProperty(GroovyFieldDoc property)
	String	commentText()
	GroovyConstructorDoc[]	constructors() returns a sorted array of constructors
	GroovyConstructorDoc[]	constructors(boolean filter)
	static String	decodeSpecialSymbols(String text)
	boolean	definesSerializableFields()
	static String	encodeAngleBrackets(String text)
	static String	encodeAngleBracketsInTagBody(String text, Pattern regex) Replaces angle brackets inside a tag.
	static String	encodeSpecialSymbols(String text)
	GroovyFieldDoc[]	enumConstants() returns a sorted array of enum constants
	GroovyFieldDoc[]	fields() returns a sorted array of fields
	GroovyFieldDoc[]	fields(boolean filter)
	GroovyClassDoc	findClass(String className)
	String	firstSentenceCommentText()
	String	getDocUrl(String type)
	String	getDocUrl(String type, boolean full)
	static String	getDocUrl(String type, boolean full, List<LinkArgument> links, String relativePath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc)
	String	getFullPathName()
	String	getNameWithTypeArgs()
	GroovyClassDoc	getOuter()
	List<GroovyClassDoc>	getParentClasses()
	Set<GroovyClassDoc>	getParentInterfaces()
	String	getRelativeRootPath()
	String	getSuperClassName()
	GroovyClassDoc[]	importedClasses()
	GroovyPackageDoc[]	importedPackages()
	GroovyClassDoc[]	innerClasses() returns a sorted array of nested classes and interfaces
	GroovyClassDoc[]	innerClasses(boolean filter)
	GroovyType[]	interfaceTypes()
	GroovyClassDoc[]	interfaces()
	boolean	isExternalizable()
	boolean	isGroovy()
	boolean	isPrimitive()
	boolean	isSerializable()
	GroovyMethodDoc[]	methods() returns a sorted array of methods
	GroovyMethodDoc[]	methods(boolean filter)
	GroovyFieldDoc[]	properties() returns a sorted array of properties
	String	qualifiedTypeName()
	String	replaceAllTags(String self, String s1, String s2, Pattern regex)
	static String	replaceAllTags(String self, String s1, String s2, Pattern regex, List<LinkArgument> links, String relPath, GroovyRootDoc rootDoc, SimpleGroovyClassDoc classDoc)
	String	replaceAllTagsCollated(String self, String preKey, String postKey, String valueSeparator, String postValues, Pattern regex)
	String	replaceTags(String comment)
	GroovyFieldDoc[]	serializableFields()
	GroovyMethodDoc[]	serializationMethods()
	void	setFullPathName(String fullPathName)
	void	setGroovy(boolean isgroovy)
	void	setNameWithTypeArgs(String nameWithTypeArgs)
	void	setOuter(GroovyClassDoc outer)
	void	setSuperClass(GroovyClassDoc doc)
	void	setSuperClassName(String className)
	String	simpleTypeName()
	boolean	subclassOf(GroovyClassDoc gcd)
	GroovyClassDoc	superclass()
	GroovyType	superclassType()
	String	typeName()

Inherited Methods Summary

Inherited Methods 

Methods inherited from class	Name
class SimpleGroovyAbstractableElementDoc	isAbstract, setAbstract
class SimpleGroovyProgramElementDoc	addAnnotationRef, annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifierSpecifier, modifiers, qualifiedName, setContainingPackage, setFinal, setPackagePrivate, setPrivate, setProtected, setPublic, setStatic
class SimpleGroovyDoc	calculateFirstSentence, commentText, compareTo, firstSentenceCommentText, getRawCommentText, getTypeDescription, getTypeSourceDescription, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isDeprecated, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, isScript, isTrait, name, setCommentText, setDeprecated, setFirstSentenceCommentText, setRawCommentText, setScript, setTokenType, tags, toString, tokenType