Admin

name	type	size	perms	modified	actions
[parent directory]
AbstractRequireOneLineDocComment.php	file	3,634 B	0644	2025-09-13 08:53:30	edit
AnnotationNameSniff.php	file	7,092 B	0644	2025-09-13 08:53:30	edit
DeprecatedAnnotationDeclarationSniff.php	file	1,326 B	0644	2025-09-13 08:53:30	edit
DisallowCommentAfterCodeSniff.php	file	4,887 B	0644	2025-09-13 08:53:30	edit
DisallowOneLinePropertyDocCommentSniff.php	file	2,713 B	0644	2025-09-13 08:53:30	edit
DocCommentSpacingSniff.php	file	25,796 B	0644	2025-09-13 08:53:30	edit
EmptyCommentSniff.php	file	6,396 B	0644	2025-09-13 08:53:30	edit
ForbiddenAnnotationsSniff.php	file	3,918 B	0644	2025-09-13 08:53:30	edit
ForbiddenCommentsSniff.php	file	3,716 B	0644	2025-09-13 08:53:30	edit
InlineDocCommentDeclarationSniff.php	file	14,314 B	0644	2025-09-13 08:53:30	edit
RequireOneLineDocCommentSniff.php	file	568 B	0644	2025-09-13 08:53:30	edit
RequireOneLinePropertyDocCommentSniff.php	file	1,933 B	0644	2025-09-13 08:53:30	edit
UselessFunctionDocCommentSniff.php	file	4,047 B	0644	2025-09-13 08:53:30	edit
UselessInheritDocCommentSniff.php	file	3,204 B	0644	2025-09-13 08:53:30	edit

editing: DeprecatedAnnotationDeclarationSniff.php

<?php declare(strict_types = 1);

namespace SlevomatCodingStandard\Sniffs\Commenting;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHPStan\PhpDocParser\Ast\PhpDoc\DeprecatedTagValueNode;
use SlevomatCodingStandard\Helpers\Annotation;
use SlevomatCodingStandard\Helpers\AnnotationHelper;
use function count;
use const T_DOC_COMMENT_OPEN_TAG;

class DeprecatedAnnotationDeclarationSniff implements Sniff
{

public const MISSING_DESCRIPTION = 'MissingDescription';

/** @return array<int, (int|string)> */
	public function register(): array
	{
		return [T_DOC_COMMENT_OPEN_TAG];
	}

/**
	 * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
	 * @param int $docCommentStartPointer
	 */
	public function process(File $phpcsFile, $docCommentStartPointer): void
	{
		/** @var list<Annotation<DeprecatedTagValueNode>> $annotations */
		$annotations = AnnotationHelper::getAnnotations($phpcsFile, $docCommentStartPointer, '@deprecated');

if (count($annotations) === 0) {
			return;
		}

foreach ($annotations as $annotation) {
			if ($annotation->getValue()->description !== '') {
				continue;
			}

$phpcsFile->addError(
				'Deprecated annotation must have a description.',
				$annotation->getStartPointer(),
				self::MISSING_DESCRIPTION,
			);
		}
	}

}

cancel