Package org.sonar.flex.checks

Class ASDocCheck

java.lang.Object

org.sonar.flex.FlexVisitor

org.sonar.flex.FlexCheck

org.sonar.flex.checks.ASDocCheck

public class ASDocCheck
extends FlexCheck

Field Summary

Fields

Modifier and Type	Field	Description
boolean	classes
static final String	INHERIT_TAG
boolean	methodParams
boolean	methodReturn
boolean	methods
static final String	PRIVATE_TAG
boolean	properties

Constructor Summary

Constructors

Constructor	Description
ASDocCheck()

Method Summary

Modifier and Type	Method	Description
boolean	containsOnOfTags(List<com.sonar.sslr.api.Trivia> trivia, String... tags)	Check if comment contains one of the string given as parameters.
boolean	hasASDoc(List<com.sonar.sslr.api.Trivia> trivia)
List<com.sonar.sslr.api.AstNodeType>	subscribedTo()
void	visitNode(com.sonar.sslr.api.AstNode astNode)

Methods inherited from class org.sonar.flex.FlexCheck

addFileIssue, addIssue, addIssue, addIssueAtLine, addIssueWithCost, scanFileForIssues

Methods inherited from class org.sonar.flex.FlexVisitor

getContext, leaveFile, leaveNode, scanFile, scanNode, visitFile, visitToken

Methods inherited from class java.lang.Object

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

Field Details

INHERIT_TAG

public static final String INHERIT_TAG

See Also:

• Constant Field Values

PRIVATE_TAG

public static final String PRIVATE_TAG

See Also:

• Constant Field Values

classes

public boolean classes

properties

public boolean properties

methods

public boolean methods

methodParams

public boolean methodParams

methodReturn

public boolean methodReturn

Constructor Details

ASDocCheck

public ASDocCheck()

Method Details

subscribedTo

public List<com.sonar.sslr.api.AstNodeType> subscribedTo()

Specified by:

subscribedTo in class FlexVisitor

visitNode

public void visitNode(com.sonar.sslr.api.AstNode astNode)

Overrides:

visitNode in class FlexVisitor

hasASDoc

public boolean hasASDoc(List<com.sonar.sslr.api.Trivia> trivia)

containsOnOfTags

public boolean containsOnOfTags(List<com.sonar.sslr.api.Trivia> trivia,
 String... tags)

Check if comment contains one of the string given as parameters.