zserio.ast

Class DocCommentClassic

java.lang.Object

zserio.ast.AstNodeBase

zserio.ast.DocComment

zserio.ast.DocCommentClassic

All Implemented Interfaces:

AstNode

public final class DocCommentClassic
extends DocComment

Class representing a single documentation comment in classic style.

Constructor Summary

Constructors

Constructor and Description
DocCommentClassic(AstLocation location, java.util.List<DocParagraph> paragraphs, boolean isSticky, boolean isOneLiner) Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(ZserioAstVisitor visitor) Accept zserio visitor.
DocComment	findParamDoc(java.lang.String paramName) Finds the documentation comment of the given parameter in this documentation comment.
java.util.List<DocParagraph>	getParagraphs() Gets doc comment paragraphs.
DocCommentClassic	toClassic() Converts the documentation comment to the classic documentation comment.
void	visitChildren(ZserioAstVisitor visitor) Visit children of the current AST node using given visitor.

Methods inherited from class zserio.ast.DocComment

isOneLiner, isSticky

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

DocCommentClassic

public DocCommentClassic(AstLocation location,
                         java.util.List<DocParagraph> paragraphs,
                         boolean isSticky,
                         boolean isOneLiner)

Constructor.

Parameters:

location - AST node location.

paragraphs - Doc comment paragraphs.

isSticky - True if the classic documentation comment is not followed by blank line.

isOneLiner - True if the documentation comment is on one line in the source.

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.

findParamDoc

public DocComment findParamDoc(java.lang.String paramName)

Description copied from class: DocComment

Finds the documentation comment of the given parameter in this documentation comment.

Specified by:

findParamDoc in class DocComment

Parameters:

paramName - Name of the parameter to find.

Returns:

Extracted documentation comment for the given parameter or null if such comment does not exist.

toClassic

public DocCommentClassic toClassic()

Description copied from class: DocComment

Converts the documentation comment to the classic documentation comment.

Specified by:

toClassic in class DocComment

Returns:

Converted classic documentation comment.

getParagraphs

public java.util.List<DocParagraph> getParagraphs()

Gets doc comment paragraphs.

Returns:

List of paragraphs.