Package org.apache.groovy.antlr

Class GroovydocVisitor

java.lang.Object

org.codehaus.groovy.ast.CodeVisitorSupport

org.codehaus.groovy.ast.ClassCodeVisitorSupport

org.apache.groovy.antlr.GroovydocVisitor

All Implemented Interfaces:

GroovyClassVisitor, GroovyCodeVisitor, ErrorCollecting

public class GroovydocVisitor
extends ClassCodeVisitorSupport

A visitor which collects Groovydoc information.

Constructor Summary

Constructors

Constructor	Description
GroovydocVisitor(SourceUnit unit, String packagePath, List<LinkArgument> links)
GroovydocVisitor(SourceUnit unit, String packagePath, List<LinkArgument> links, Properties properties)

Method Summary

Modifier and Type	Method	Description
Map<String,GroovyClassDoc>	getGroovyClassDocs()
protected SourceUnit	getSourceUnit()
void	visitClass(ClassNode node)	Visit a ClassNode.
void	visitConstructor(ConstructorNode node)	Visit a ConstructorNode.
void	visitDeclarationExpression(DeclarationExpression expression)
void	visitField(FieldNode node)	Visit a FieldNode.
void	visitMethod(MethodNode node)	Visit a MethodNode.
void	visitProperty(PropertyNode node)	Visit a PropertyNode.

Methods inherited from class org.codehaus.groovy.ast.ClassCodeVisitorSupport

addError, visitAnnotation, visitAnnotations, visitAnnotations, visitAssertStatement, visitBlockStatement, visitBreakStatement, visitCaseStatement, visitCatchStatement, visitClassCodeContainer, visitClosureExpression, visitConstructorOrMethod, visitContinueStatement, visitDoWhileLoop, visitExpressionStatement, visitForLoop, visitIfElse, visitImports, visitObjectInitializerStatements, visitPackage, visitReturnStatement, visitStatement, visitSwitch, visitSynchronizedStatement, visitThrowStatement, visitTryCatchFinally, visitWhileLoop

Methods inherited from class org.codehaus.groovy.ast.CodeVisitorSupport

afterSwitchCaseStatementsVisited, afterSwitchConditionExpressionVisited, visitArgumentlistExpression, visitArrayExpression, visitAttributeExpression, visitBinaryExpression, visitBitwiseNegationExpression, visitBooleanExpression, visitBytecodeExpression, visitCastExpression, visitClassExpression, visitClosureListExpression, visitConstantExpression, visitConstructorCallExpression, visitEmptyStatement, visitFieldExpression, visitGStringExpression, visitLambdaExpression, visitListExpression, visitMapEntryExpression, visitMapExpression, visitMethodCallExpression, visitMethodPointerExpression, visitMethodReferenceExpression, visitNotExpression, visitPostfixExpression, visitPrefixExpression, visitPropertyExpression, visitRangeExpression, visitShortTernaryExpression, visitSpreadExpression, visitSpreadMapExpression, visitStaticMethodCallExpression, visitTernaryExpression, visitTupleExpression, visitUnaryMinusExpression, visitUnaryPlusExpression, visitVariableExpression

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.codehaus.groovy.ast.GroovyCodeVisitor

visit, visit, visitEmptyExpression, visitListOfExpressions

Constructor Details

GroovydocVisitor

public GroovydocVisitor(SourceUnit unit,
 String packagePath,
 List<LinkArgument> links)

GroovydocVisitor

public GroovydocVisitor(SourceUnit unit,
 String packagePath,
 List<LinkArgument> links,
 Properties properties)

Method Details

getSourceUnit

protected SourceUnit getSourceUnit()

Specified by:

getSourceUnit in class ClassCodeVisitorSupport

visitClass

public void visitClass(ClassNode node)

Description copied from interface: GroovyClassVisitor

Visit a ClassNode.

Specified by:

visitClass in interface GroovyClassVisitor

Overrides:

visitClass in class ClassCodeVisitorSupport

visitConstructor

public void visitConstructor(ConstructorNode node)

Description copied from interface: GroovyClassVisitor

Visit a ConstructorNode.

Specified by:

visitConstructor in interface GroovyClassVisitor

Overrides:

visitConstructor in class ClassCodeVisitorSupport

visitMethod

public void visitMethod(MethodNode node)

Description copied from interface: GroovyClassVisitor

Visit a MethodNode.

Specified by:

visitMethod in interface GroovyClassVisitor

Overrides:

visitMethod in class ClassCodeVisitorSupport

visitProperty

public void visitProperty(PropertyNode node)

Description copied from interface: GroovyClassVisitor

Visit a PropertyNode.

Specified by:

visitProperty in interface GroovyClassVisitor

Overrides:

visitProperty in class ClassCodeVisitorSupport

visitDeclarationExpression

public void visitDeclarationExpression(DeclarationExpression expression)

Specified by:

visitDeclarationExpression in interface GroovyCodeVisitor

Overrides:

visitDeclarationExpression in class ClassCodeVisitorSupport

visitField

public void visitField(FieldNode node)

Description copied from interface: GroovyClassVisitor

Visit a FieldNode.

Specified by:

visitField in interface GroovyClassVisitor

Overrides:

visitField in class ClassCodeVisitorSupport

getGroovyClassDocs

public Map<String,GroovyClassDoc> getGroovyClassDocs()