com.puppycrawl.tools.checkstyle.grammars

Interface CommentListener

All Known Implementing Classes:

FileContents

public interface CommentListener

This interface is used to be notified by parser about comments in the parsed code.

Author:

o_sukhodolsky

Method Summary

Modifier and Type	Method and Description
void	reportBlockComment(String type, int startLineNo, int startColNo, int endLineNo, int endColNo) Report the location of a block comment that can span multiple lines.
void	reportSingleLineComment(String type, int startLineNo, int startColNo) Report the location of a single line comment that extends from the given point to the end of the line.

Method Detail

reportSingleLineComment

void reportSingleLineComment(String type,
                             int startLineNo,
                             int startColNo)

Report the location of a single line comment that extends from the given point to the end of the line. The type of comment is identified by a String whose value depends on the language being parsed, but would typically be the delimiter for the comment.

Parameters:

type - an identifier for what type of comment it is.

startLineNo - the starting line number

startColNo - the starting column number

reportBlockComment

void reportBlockComment(String type,
                        int startLineNo,
                        int startColNo,
                        int endLineNo,
                        int endColNo)

Report the location of a block comment that can span multiple lines. The type of comment is identified by a String whose value depends on the language being parsed, but would typically be the delimiter for the comment.

Parameters:

type - an identifier for what type of comment it is.

startLineNo - the starting line number

startColNo - the starting column number

endLineNo - the ending line number

endColNo - the ending column number