Class NamedParameterComment

java.lang.Object

com.google.errorprone.bugpatterns.argumentselectiondefects.NamedParameterComment

public final class NamedParameterComment
extends Object

Helper methods for checking if a commented argument matches a formal parameter and for generating comments in the right format.

We look for a NamedParameterComment: this is the last block comment before the argument which ends with an equals sign.

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	PARAMETER_COMMENT_PATTERN

Method Summary

Modifier and Type	Method	Description
static boolean	containsSyntheticParameterName(com.sun.tools.javac.code.Symbol.MethodSymbol sym)	Returns true if the method has synthetic parameter names, indicating the real names are not available.

Methods inherited from class java.lang.Object

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

Field Details

PARAMETER_COMMENT_PATTERN

public static final Pattern PARAMETER_COMMENT_PATTERN

Method Details

containsSyntheticParameterName

public static boolean containsSyntheticParameterName(com.sun.tools.javac.code.Symbol.MethodSymbol sym)

Returns true if the method has synthetic parameter names, indicating the real names are not available.