Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x

RequireOneLineDocCommentSniff.php

Namespace

SlevomatCodingStandard\Sniffs\Commenting

File

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

View source
<?php

declare (strict_types=1);
namespace SlevomatCodingStandard\Sniffs\Commenting;

use PHP_CodeSniffer\Files\File;
class RequireOneLineDocCommentSniff extends AbstractRequireOneLineDocComment {
    public const CODE_MULTI_LINE_DOC_COMMENT = 'MultiLineDocComment';
    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);
    }

}

Classes

Title Deprecated Summary
RequireOneLineDocCommentSniff
RSS feed
Powered by Drupal