public class GroovydocVisitor
extends ClassCodeVisitorSupportA visitor which collects Groovydoc information.
| Constructor and description |
|---|
GroovydocVisitor(SourceUnit unit, String packagePath, List<LinkArgument> links)Creates a visitor that collects Groovydoc for classes in the given package. |
GroovydocVisitor(SourceUnit unit, String packagePath, List<LinkArgument> links, Properties properties)Creates a visitor that collects Groovydoc for classes in the given package, using the supplied generation properties. |
| Type Params | Return Type | Name and description |
|---|---|---|
|
public Map<String, GroovyClassDoc> |
getGroovyClassDocs()Returns the collected class documentation, keyed by full path name. |
|
protected SourceUnit |
getSourceUnit()* Provides access to the SourceUnit for error reporting during visitation. * Implementations must override this method. * *
|
|
public void |
visitClass(ClassNode node)* Visits a ClassNode, processing its annotations, package, imports, contents, and object initializers. * *
|
|
public void |
visitConstructor(ConstructorNode node)* Visits a ConstructorNode, processing its annotations, parameter annotations, and code block. * *
|
|
public void |
visitDeclarationExpression(DeclarationExpression expression)* Visits a DeclarationExpression with annotation processing, traversing expression annotations * before delegating to parent traversal. * *
|
|
public void |
visitField(FieldNode node)* Visits a FieldNode, processing its annotations and initial value expression if present. * *
|
|
public void |
visitMethod(MethodNode node)* Visits a MethodNode, processing its annotations, parameter annotations, and code block. * *
|
|
public void |
visitProperty(PropertyNode node)* Visits a PropertyNode, processing its annotations, initial value expression, * and getter/setter blocks if present. * *
|
Creates a visitor that collects Groovydoc for classes in the given package.
Creates a visitor that collects Groovydoc for classes in the given package, using the supplied generation properties.
Returns the collected class documentation, keyed by full path name.
* Provides access to the SourceUnit for error reporting during visitation. * Implementations must override this method. * *
* Visits a ClassNode, processing its annotations, package, imports, contents, and object initializers. * *
node - the class node to visit* Visits a ConstructorNode, processing its annotations, parameter annotations, and code block. * *
node - the constructor node to visit* Visits a DeclarationExpression with annotation processing, traversing expression annotations * before delegating to parent traversal. * *
expression - the declaration expression to visit* Visits a FieldNode, processing its annotations and initial value expression if present. * *
node - the field node to visit* Visits a MethodNode, processing its annotations, parameter annotations, and code block. * *
node - the method node to visit* Visits a PropertyNode, processing its annotations, initial value expression, * and getter/setter blocks if present. * *
node - the property node to visitCopyright © 2003-2026 The Apache Software Foundation. All rights reserved.