zserio.ast

Class DocComment

java.lang.Object

zserio.ast.AstNodeBase

zserio.ast.DocComment

All Implemented Interfaces:

AstNode

Direct Known Subclasses:

DocCommentClassic, DocCommentMarkdown

public abstract class DocComment
extends AstNodeBase

Base class representing a single documentation comment.

Constructor Summary

Constructors

Constructor and Description
DocComment(AstLocation location, boolean isSticky, boolean isOneLiner) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract DocComment	findParamDoc(java.lang.String paramName) Finds the documentation comment of the given parameter in this documentation comment.
boolean	isOneLiner() Checks if the documentation comment is one-liner.
boolean	isSticky() Checks if the documentation comment is sticky.
abstract DocCommentClassic	toClassic() Converts the documentation comment to the classic documentation comment.

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

Methods inherited from interface zserio.ast.AstNode

accept

Constructor Detail

DocComment

public DocComment(AstLocation location,
                  boolean isSticky,
                  boolean isOneLiner)

Constructor.

Parameters:

location - AST node location.

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

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

Method Detail

isSticky

public boolean isSticky()

Checks if the documentation comment is sticky.

Returns:

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

isOneLiner

public boolean isOneLiner()

Checks if the documentation comment is one-liner.

Returns:

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

findParamDoc

public abstract DocComment findParamDoc(java.lang.String paramName)

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

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 abstract DocCommentClassic toClassic()

Converts the documentation comment to the classic documentation comment.

Returns:

Converted classic documentation comment.