class RequireOneLineDocCommentSniff

Hierarchy

class \SlevomatCodingStandard\Sniffs\Commenting\AbstractRequireOneLineDocComment implements \PHP_CodeSniffer\Sniffs\Sniff
- class \SlevomatCodingStandard\Sniffs\Commenting\RequireOneLineDocCommentSniff extends \SlevomatCodingStandard\Sniffs\Commenting\AbstractRequireOneLineDocComment

Expanded class hierarchy of RequireOneLineDocCommentSniff

File

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

Namespace

SlevomatCodingStandard\Sniffs\Commenting

View source

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);
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
AbstractRequireOneLineDocComment::process	public	function	* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint *	Overrides Sniff::process	1
AbstractRequireOneLineDocComment::register	public	function	*	Overrides Sniff::register
RequireOneLineDocCommentSniff::addError	protected	function		Overrides AbstractRequireOneLineDocComment::addError
RequireOneLineDocCommentSniff::CODE_MULTI_LINE_DOC_COMMENT	public	constant