zserio.ast

Class DocCommentMarkdown

java.lang.Object

zserio.ast.AstNodeBase

zserio.ast.DocComment

zserio.ast.DocCommentMarkdown

All Implemented Interfaces:

AstNode

public final class DocCommentMarkdown
extends DocComment

Class representing a single documentation comment in markdown style.

Constructor Summary

Constructors

Constructor and Description
DocCommentMarkdown(AstLocation location, java.lang.String markdown, boolean isSticky, boolean isOneLiner, boolean isIndented) 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.lang.String	getMarkdown() Gets markdown documentation.
DocCommentClassic	toClassic() Converts this markdown 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

DocCommentMarkdown

public DocCommentMarkdown(AstLocation location,
                          java.lang.String markdown,
                          boolean isSticky,
                          boolean isOneLiner,
                          boolean isIndented)

Constructor.

Parameters:

location - AST node location.

markdown - Markdown documentation.

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

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

isIndented - True if all lines are indented at least as the begin-comment delimiter.

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()

Converts this markdown documentation comment to the classic documentation comment. The following actions during conversion are performed: 1. Markdown documentation comments is split up to the paragraphs according to the empty lines. 2. Each markdown link in format [alias](../path/schema_file.zs#zserio_type) is converted to the see tag.

Specified by:

toClassic in class DocComment

Returns:

Converted classic documentation comment.

getMarkdown

public java.lang.String getMarkdown()

Gets markdown documentation.

Returns:

Markdown documentation.