zserio.ast

Class DocumentableAstNode

java.lang.Object

zserio.ast.AstNodeBase

zserio.ast.DocumentableAstNode

All Implemented Interfaces:

AstNode

Direct Known Subclasses:

BitmaskType, BitmaskValue, ChoiceCaseExpression, ChoiceDefault, CompatibilityVersion, CompoundType, Constant, EnumItem, EnumType, Field, Function, Import, InstantiateType, Package, PubsubMessage, PubsubType, Rule, RuleGroup, ServiceMethod, ServiceType, Subtype

public abstract class DocumentableAstNode
extends AstNodeBase

AST node which can have documentation comment.

Constructor Summary

Constructors

Constructor and Description
DocumentableAstNode(AstLocation location, java.util.List<DocComment> docComments) Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.List<DocComment>	getDocComments() Gets documentation comments belonging to this node.
void	visitChildren(ZserioAstVisitor visitor) Visit children of the current AST node using given visitor.

Methods inherited from class zserio.ast.AstNodeBase

getLocation

Methods inherited from class java.lang.Object

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

Methods inherited from interface zserio.ast.AstNode

accept

Constructor Detail

DocumentableAstNode

public DocumentableAstNode(AstLocation location,
                           java.util.List<DocComment> docComments)

Constructor.

Parameters:

location - AST node location.

docComments - List of documentation comments belonging to this node.

Method Detail

visitChildren

public void visitChildren(ZserioAstVisitor visitor)

Description copied from interface: AstNode

Visit children of the current AST node using given visitor.

Specified by:

visitChildren in interface AstNode

Overrides:

visitChildren in class AstNodeBase

Parameters:

visitor - Visitor to use.

getDocComments

public java.util.List<DocComment> getDocComments()

Gets documentation comments belonging to this node.

Returns:

List of documentation comments.