zserio.ast

Class DocTagParam

java.lang.Object

zserio.ast.AstNodeBase

zserio.ast.DocMultiline

zserio.ast.DocTagParam

All Implemented Interfaces:

AstNode

public final class DocTagParam
extends DocMultiline

Param tag documentation node used to document parameters.

Constructor Summary

Constructors

Constructor and Description
DocTagParam(AstLocation location, java.lang.String paramName, DocLine firstLine) Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(ZserioAstVisitor visitor) Accept zserio visitor.
java.lang.String	getParamName() Gets parameter name.

Methods inherited from class zserio.ast.DocMultiline

getLines, visitChildren

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

DocTagParam

public DocTagParam(AstLocation location,
                   java.lang.String paramName,
                   DocLine firstLine)

Constructor.

Parameters:

location - Location of this AST node.

paramName - Parameter name.

firstLine - First line of parameter description.

Method Detail

accept

public void accept(ZserioAstVisitor visitor)

Description copied from interface: AstNode

Accept zserio visitor.

Specified by:

accept in interface AstNode

Overrides:

accept in class DocMultiline

Parameters:

visitor - Visitor to accept.

getParamName

public java.lang.String getParamName()

Gets parameter name.

Returns:

Parameter name.