zserio.ast

Class DocElement

java.lang.Object

zserio.ast.AstNodeBase

zserio.ast.DocElement

All Implemented Interfaces:

AstNode

public final class DocElement
extends AstNodeBase

Documentation node which wraps documentation element which can be either a text or a tag.

Constructor Summary

Constructors

Constructor and Description
DocElement(AstLocation location, DocMultiline docMultiline) Constructor from multiline.
DocElement(AstLocation location, DocTagDeprecated deprecatedTag) Constructor from deprecated tag.
DocElement(AstLocation location, DocTagParam paramTag) Constructor from param tag.
DocElement(AstLocation location, DocTagSee seeTag) Constructor from see tag.
DocElement(AstLocation location, DocTagTodo todoTag) Constructor from todo tag.

Method Summary

Modifier and Type	Method and Description
void	accept(ZserioAstVisitor visitor) Accept zserio visitor.
DocTagDeprecated	getDeprecatedTag() Gets documentation deprecated tag if available.
DocMultiline	getDocMultiline() Gets documentation multiline text if available.
DocTagParam	getParamTag() Gets documentation param tag if available.
DocTagSee	getSeeTag() Gets documentation see tag if available.
DocTagTodo	getTodoTag() Gets documentation todo tag if available.
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

Constructor Detail

DocElement

public DocElement(AstLocation location,
                  DocMultiline docMultiline)

Constructor from multiline.

Parameters:

location - Location of this AST node.

docMultiline - Multiline AST node.

DocElement

public DocElement(AstLocation location,
                  DocTagSee seeTag)

Constructor from see tag.

Parameters:

location - AST node location.

seeTag - See tag.

DocElement

public DocElement(AstLocation location,
                  DocTagTodo todoTag)

Constructor from todo tag.

Parameters:

location - AST node location.

todoTag - Todo tag.

DocElement

public DocElement(AstLocation location,
                  DocTagParam paramTag)

Constructor from param tag.

Parameters:

location - AST node location.

paramTag - Param tag.

DocElement

public DocElement(AstLocation location,
                  DocTagDeprecated deprecatedTag)

Constructor from deprecated tag.

Parameters:

location - AST node location.

deprecatedTag - Deprecated tag.

Method Detail

accept

public void accept(ZserioAstVisitor visitor)

Description copied from interface: AstNode

Accept zserio visitor.

Parameters:

visitor - Visitor to accept.

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.

getDocMultiline

public DocMultiline getDocMultiline()

Gets documentation multiline text if available.

Returns:

Multiline text or null.

getSeeTag

public DocTagSee getSeeTag()

Gets documentation see tag if available.

Returns:

See tag or null.

getTodoTag

public DocTagTodo getTodoTag()

Gets documentation todo tag if available.

Returns:

Todo tag or null.

getParamTag

public DocTagParam getParamTag()

Gets documentation param tag if available.

Returns:

Param tag or null.

getDeprecatedTag

public DocTagDeprecated getDeprecatedTag()

Gets documentation deprecated tag if available.

Returns:

Deprecated tag or null.