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

Class InternalCommentParser

java.lang.Object

org.sonarsource.analyzer.commons.checks.verifier.internal.InternalCommentParser

All Implemented Interfaces:

CommentParser

public class InternalCommentParser
extends Object
implements CommentParser

Constructor Summary

Constructors

Constructor	Description
InternalCommentParser()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalCommentParser

public InternalCommentParser()

Method Detail

addSingleLineCommentSyntax

public InternalCommentParser addSingleLineCommentSyntax(String commentPrefix)

Description copied from interface: CommentParser

 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("//");
 

Specified by:

addSingleLineCommentSyntax in interface CommentParser

parseInto

public void parseInto(Path path,
                      MultiFileVerifier verifier)

Specified by:

parseInto in interface CommentParser

Parameters:

path - source file to parse

verifier - verifier for feed

parseInto

public void parseInto(Path path,
                      SingleFileVerifier verifier)

Specified by:

parseInto in interface CommentParser

Parameters:

path - source file to parse

verifier - verifier for feed