Top Description Fields Constructors Methods

org.apache.groovy.parser.antlr4

public Class GroovydocManager

Class Inheritance

extends Object

java.lang.Object
org.apache.groovy.parser.antlr4.GroovydocManager

Imports

groovy.lang.Groovydoc, groovy.lang.groovydoc.GroovydocHolder, org.antlr.v4.runtime.ParserRuleContext, org.antlr.v4.runtime.tree.ParseTree, .TerminalNode, org.codehaus.groovy.GroovyBugError, org.codehaus.groovy.ast.ASTNode, .AnnotatedNode, .AnnotationNode, .ClassHelper, org.codehaus.groovy.ast.expr.ConstantExpression, java.util.List, java.util.regex.Pattern

A utilities for managing groovydoc, e.g. 1) extracting groovydoc from groovy AST; 2) TODO extracting tags from groovydoc; 3) attach groovydoc to AST node as metadata

Field Summary

Modifier and Type	Field and Description
public static final String	DOC_COMMENT
private static final String	GROOVYDOC_PREFIX
private final boolean	groovydocEnabled
private static final String	RUNTIME_GROOVYDOC_PREFIX
private final boolean	runtimeGroovydocEnabled
private static final Pattern	SPACES_PATTERN
private static final String	VALUE

Constructor Summary

Access	Constructor and Description
public	GroovydocManager(final boolean groovydocEnabled, final boolean runtimeGroovydocEnabled)

Method Summary

Modifier and Type	Method and Description
private void	attachDocCommentAsMetaData(ASTNode node, String docCommentNodeText)
private void	attachGroovydocAnnotation(ASTNode node, String docCommentNodeText)
private String	findDocCommentByNode(ParserRuleContext node)
public void	handle(ASTNode node, GroovyParser.GroovyParserRuleContext ctx) Attach doc comment to member node as meta data

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DOC_COMMENT	back to summary
public static final String DOC_COMMENT

GROOVYDOC_PREFIX	back to summary
private static final String GROOVYDOC_PREFIX

groovydocEnabled	back to summary
private final boolean groovydocEnabled

RUNTIME_GROOVYDOC_PREFIX	back to summary
private static final String RUNTIME_GROOVYDOC_PREFIX

runtimeGroovydocEnabled	back to summary
private final boolean runtimeGroovydocEnabled

SPACES_PATTERN	back to summary
private static final Pattern SPACES_PATTERN

VALUE	back to summary
private static final String VALUE

Constructor Detail

GroovydocManager	back to summary
public GroovydocManager(final boolean groovydocEnabled, final boolean runtimeGroovydocEnabled)

Method Detail

attachDocCommentAsMetaData	back to summary
private void attachDocCommentAsMetaData(ASTNode node, String docCommentNodeText)

attachGroovydocAnnotation	back to summary
private void attachGroovydocAnnotation(ASTNode node, String docCommentNodeText)

findDocCommentByNode	back to summary
private String findDocCommentByNode(ParserRuleContext node)

handle	back to summary
public void handle(ASTNode node, GroovyParser.GroovyParserRuleContext ctx) Attach doc comment to member node as meta data