function RequireOneLineDocCommentSniff::addError

Overrides AbstractRequireOneLineDocComment::addError

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/RequireOneLineDocCommentSniff.php, line 12

Class

RequireOneLineDocCommentSniff

Namespace

SlevomatCodingStandard\Sniffs\Commenting

Code

protected function addError(File $phpcsFile, int $docCommentStartPointer) : bool {
    $error = 'Found multi-line doc comment with single line content, use one-line doc comment instead.';
    return $phpcsFile->addFixableError($error, $docCommentStartPointer, self::CODE_MULTI_LINE_DOC_COMMENT);
}