Package com._1c.g5.v8.dt.bsl.documentation.comment.parser

Class BslDocCommentBuilderListener

java.lang.Object

com._1c.g5.v8.dt.bsl.documentation.comment.parser.BslDocParserBaseListener

com._1c.g5.v8.dt.bsl.documentation.comment.parser.BslDocCommentBuilderListener

All Implemented Interfaces:

BslDocParserListener, org.antlr.v4.runtime.tree.ParseTreeListener

public class BslDocCommentBuilderListener
extends BslDocParserBaseListener

Special listener for creating BslDocumentationComment for new format. This listener used in ANTLR v4 comment content parsing

Constructor Summary

Constructors

Constructor	Description
BslDocCommentBuilderListener(BslDocumentationComment comment)	Constructor

Method Summary

Modifier and Type	Method	Description
void	enterCallOptionsSection(BslDocParser.CallOptionsSectionContext ctx)	Enter a parse tree produced by BslDocParser.callOptionsSection().
void	enterExampleSection(BslDocParser.ExampleSectionContext ctx)	Enter a parse tree produced by BslDocParser.exampleSection().
void	enterParametersSection(BslDocParser.ParametersSectionContext ctx)	Enter a parse tree produced by BslDocParser.parametersSection().
void	enterReturnSection(BslDocParser.ReturnSectionContext ctx)	Enter a parse tree produced by BslDocParser.returnSection().
void	exitCallOptionsSection(BslDocParser.CallOptionsSectionContext ctx)	Exit a parse tree produced by BslDocParser.callOptionsSection().
void	exitDocument(BslDocParser.DocumentContext ctx)	Exit a parse tree produced by BslDocParser.document().
void	exitExampleSection(BslDocParser.ExampleSectionContext ctx)	Exit a parse tree produced by BslDocParser.exampleSection().
void	exitParametersSection(BslDocParser.ParametersSectionContext ctx)	Exit a parse tree produced by BslDocParser.parametersSection().
void	exitReturnSection(BslDocParser.ReturnSectionContext ctx)	Exit a parse tree produced by BslDocParser.returnSection().
BslDocumentationComment	getComment()	Gets filled BslDocumentationComment after parsing

Methods inherited from class com._1c.g5.v8.dt.bsl.documentation.comment.parser.BslDocParserBaseListener

enterContent, enterDocument, enterEveryRule, enterLink, enterSpace, enterTypeSection, exitContent, exitEveryRule, exitLink, exitSpace, exitTypeSection, visitErrorNode, visitTerminal

Methods inherited from class java.lang.Object

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

Constructor Detail

BslDocCommentBuilderListener

public BslDocCommentBuilderListener(BslDocumentationComment comment)

Constructor

Parameters:

comment - BslDocumentationComment for filling, cannot null

Method Detail

getComment

public BslDocumentationComment getComment()

Gets filled BslDocumentationComment after parsing

Returns:

filled BslDocumentationComment after parsing, never null

enterParametersSection

public void enterParametersSection(BslDocParser.ParametersSectionContext ctx)

Description copied from class: BslDocParserBaseListener

Enter a parse tree produced by BslDocParser.parametersSection().

The default implementation does nothing.

Specified by:

enterParametersSection in interface BslDocParserListener

Overrides:

enterParametersSection in class BslDocParserBaseListener

Parameters:

ctx - the parse tree

exitParametersSection

public void exitParametersSection(BslDocParser.ParametersSectionContext ctx)

Description copied from class: BslDocParserBaseListener

Exit a parse tree produced by BslDocParser.parametersSection().

The default implementation does nothing.

Specified by:

exitParametersSection in interface BslDocParserListener

Overrides:

exitParametersSection in class BslDocParserBaseListener

Parameters:

ctx - the parse tree

enterReturnSection

public void enterReturnSection(BslDocParser.ReturnSectionContext ctx)

Description copied from class: BslDocParserBaseListener

Enter a parse tree produced by BslDocParser.returnSection().

The default implementation does nothing.

Specified by:

enterReturnSection in interface BslDocParserListener

Overrides:

enterReturnSection in class BslDocParserBaseListener

Parameters:

ctx - the parse tree

exitReturnSection

public void exitReturnSection(BslDocParser.ReturnSectionContext ctx)

Description copied from class: BslDocParserBaseListener

Exit a parse tree produced by BslDocParser.returnSection().

The default implementation does nothing.

Specified by:

exitReturnSection in interface BslDocParserListener

Overrides:

exitReturnSection in class BslDocParserBaseListener

Parameters:

ctx - the parse tree

enterExampleSection

public void enterExampleSection(BslDocParser.ExampleSectionContext ctx)

Description copied from class: BslDocParserBaseListener

Enter a parse tree produced by BslDocParser.exampleSection().

The default implementation does nothing.

Specified by:

enterExampleSection in interface BslDocParserListener

Overrides:

enterExampleSection in class BslDocParserBaseListener

Parameters:

ctx - the parse tree

exitExampleSection

public void exitExampleSection(BslDocParser.ExampleSectionContext ctx)

Description copied from class: BslDocParserBaseListener

Exit a parse tree produced by BslDocParser.exampleSection().

The default implementation does nothing.

Specified by:

exitExampleSection in interface BslDocParserListener

Overrides:

exitExampleSection in class BslDocParserBaseListener

Parameters:

ctx - the parse tree

enterCallOptionsSection

public void enterCallOptionsSection(BslDocParser.CallOptionsSectionContext ctx)

Description copied from class: BslDocParserBaseListener

Enter a parse tree produced by BslDocParser.callOptionsSection().

The default implementation does nothing.

Specified by:

enterCallOptionsSection in interface BslDocParserListener

Overrides:

enterCallOptionsSection in class BslDocParserBaseListener

Parameters:

ctx - the parse tree

exitCallOptionsSection

public void exitCallOptionsSection(BslDocParser.CallOptionsSectionContext ctx)

Description copied from class: BslDocParserBaseListener

Exit a parse tree produced by BslDocParser.callOptionsSection().

The default implementation does nothing.

Specified by:

exitCallOptionsSection in interface BslDocParserListener

Overrides:

exitCallOptionsSection in class BslDocParserBaseListener

Parameters:

ctx - the parse tree

exitDocument

public void exitDocument(BslDocParser.DocumentContext ctx)

Description copied from class: BslDocParserBaseListener

Exit a parse tree produced by BslDocParser.document().

The default implementation does nothing.

Specified by:

exitDocument in interface BslDocParserListener

Overrides:

exitDocument in class BslDocParserBaseListener

Parameters:

ctx - the parse tree