Package org.sonarsource.analyzer.commons.checks.verifier

Interface CommentParser

All Known Implementing Classes:

InternalCommentParser

public interface CommentParser

Method Summary

Modifier and Type	Method	Description
CommentParser	addSingleLineCommentSyntax(String commentPrefix)	This comment parser is able split a line using "commentPrefix".
static CommentParser	create()
void	parseInto(Path path, MultiFileVerifier verifier)
void	parseInto(Path path, SingleFileVerifier verifier)

Method Detail

create

static CommentParser create()

addSingleLineCommentSyntax

CommentParser addSingleLineCommentSyntax(String commentPrefix)

 This comment parser is able split a line using "commentPrefix".
 But there's some limitation, like for this case in java:
 String name = "Paul//Smith"; // Noncompliant
 Example:
   parser.addSingleLineCommentSyntax("//");
 

parseInto

void parseInto(Path path,
               MultiFileVerifier verifier)

Parameters:

path - source file to parse

verifier - verifier for feed

parseInto

void parseInto(Path path,
               SingleFileVerifier verifier)

Parameters:

path - source file to parse

verifier - verifier for feed