com.puppycrawl.tools.checkstyle.grammars
Interface CommentListener
- FileContents
public interface CommentListener
This interface is used to be notified by parser about comments
in the parsed code.
void | reportBlockComment(String aType, int aStartLineNo, int aStartColNo, int aEndLineNo, int aEndColNo)- Report the location of a block comment that can span multiple lines.
|
void | reportSingleLineComment(String aType, int aStartLineNo, int aStartColNo)- Report the location of a single line comment that extends from the
given point to the end of the line.
|
reportBlockComment
public void reportBlockComment(String aType,
int aStartLineNo,
int aStartColNo,
int aEndLineNo,
int aEndColNo) 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.
aType - an identifier for what type of comment it is.aStartLineNo - the starting line numberaStartColNo - the starting column numberaEndLineNo - the ending line numberaEndColNo - the ending column number
reportSingleLineComment
public void reportSingleLineComment(String aType,
int aStartLineNo,
int aStartColNo) 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.
aType - an identifier for what type of comment it is.aStartLineNo - the starting line numberaStartColNo - the starting column number