Deprecated items do not need a description (moodlehq#139)

andrewnicols · Mar 29, 2024 · b425006 · b425006
1 parent baeb6d5
commit b425006
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/moodle/Sniffs/Commenting/DocblockDescriptionSniff.php b/moodle/Sniffs/Commenting/DocblockDescriptionSniff.php
@@ -79,6 +79,12 @@ public function process(File $phpcsFile, $stackPtr) {
             }
             $faultAtLine = $tokens[$stopAt]['line'];
 
+            $deprecatedTagPtrs = Docblocks::getMatchingDocTags($phpcsFile, $docblockPtr, '@deprecated');
+            if (count($deprecatedTagPtrs) > 0) {
+                // Skip if the docblock contains a @deprecated tag.
+                continue;
+            }
+
             // Skip to the next T_DOC_COMMENT_STAR line. We do not accept single line docblocks.
             $docblockLinePtr = $docblockPtr;
             while ($docblockLinePtr = $phpcsFile->findNext(T_DOC_COMMENT_STAR, $docblockLinePtr + 1, $stopAt)) {

diff --git a/moodle/Tests/Sniffs/Commenting/fixtures/DocblockDescription/standard.php b/moodle/Tests/Sniffs/Commenting/fixtures/DocblockDescription/standard.php
@@ -58,3 +58,8 @@ trait trait_with_docblock_but_no_description {}
  * @license
  */
 function function_with_docblock_but_no_description() {}
+
+/**
+ * @deprecated
+ */
+function function_with_deprecated_tag() {}