zserio.ast

Class DocTagSee

java.lang.Object

zserio.ast.AstNodeBase

zserio.ast.DocTagSee

All Implemented Interfaces:

AstNode

public final class DocTagSee
extends AstNodeBase

See tag documentation node.

Constructor Summary

Constructors

Constructor and Description
DocTagSee(AstLocation location, java.lang.String linkAlias, java.lang.String linkName) Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(ZserioAstVisitor visitor) Accept zserio visitor.
java.lang.String	getLinkAlias() Gets see tag link alias.
java.lang.String	getLinkName() Gets see tag link name.
SymbolReference	getLinkSymbolReference() Gets reference to symbol which see tag points to.

Methods inherited from class zserio.ast.AstNodeBase

getLocation, visitChildren

Methods inherited from class java.lang.Object

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

Constructor Detail

DocTagSee

public DocTagSee(AstLocation location,
                 java.lang.String linkAlias,
                 java.lang.String linkName)

Constructor.

Parameters:

location - Location of this AST node.

linkAlias - Link alias. Defaults to link name if null is passed.

linkName - Link name.

Method Detail

accept

public void accept(ZserioAstVisitor visitor)

Description copied from interface: AstNode

Accept zserio visitor.

Parameters:

visitor - Visitor to accept.

getLinkAlias

public java.lang.String getLinkAlias()

Gets see tag link alias.

Returns:

Link alias.

getLinkName

public java.lang.String getLinkName()

Gets see tag link name.

Returns:

Link name.

getLinkSymbolReference

public SymbolReference getLinkSymbolReference()

Gets reference to symbol which see tag points to.

Returns:

Symbol reference.