Merge pull request #181 from sinisa86/ticket-162

#162 Modified @deprecated validator to consider it valid if comment is absent but @see tag is set
magento · Sep 2, 2020 · 7f6fd20 · 7f6fd20
2 parents ea0eb81 + 4bd4113
commit 7f6fd20
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 8 deletions.
diff --git a/Magento2/Helpers/Commenting/PHPDocFormattingValidator.php b/Magento2/Helpers/Commenting/PHPDocFormattingValidator.php
@@ -122,19 +122,15 @@ public function hasDeprecatedWellFormatted($commentStartPtr, $tokens)
             return true;
         }
 
+        $seeTagRequired = false;
         if ($tokens[$deprecatedPtr + 2]['code'] !== T_DOC_COMMENT_STRING) {
-            return false;
+            $seeTagRequired = true;
         }
-
         $seePtr = $this->getTagPosition('@see', $commentStartPtr, $tokens);
         if ($seePtr === -1) {
-            return true;
+            return !$seeTagRequired;
         }
-        if ($tokens[$seePtr + 2]['code'] !== T_DOC_COMMENT_STRING) {
-            return false;
-        }
-
-        return true;
+        return $tokens[$seePtr + 2]['code'] === T_DOC_COMMENT_STRING;
     }
 
     /**

diff --git a/Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.1.inc b/Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.1.inc
@@ -153,3 +153,12 @@ class DoNotCareHandler
 {
 
 }
+
+/**
+ * @deprecated
+ * @see Magento\Framework\NewHandler
+ */
+class OldHandler
+{
+
+}
diff --git a/Magento2/Tests/Commenting/ConstantsPHPDocFormattingUnitTest.1.inc b/Magento2/Tests/Commenting/ConstantsPHPDocFormattingUnitTest.1.inc
@@ -38,6 +38,12 @@ class Profiler
      */
     const COMPUTER = 'Deep Thought';
 
+    /**
+     * @deprecated
+     * @see \ComputationalMatrix\Mars
+     */
+    const KEYBOARD = 'Ergonomic';
+
     /**
      * @see
      */