magento#162 Modified @deprecated validator to consider it valid if co…

…mment is absent but @see tag is set
sinisa86 · Apr 4, 2020 · 6a3f52f · 6a3f52f
1 parent 919dcc1
commit 6a3f52f
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 2 deletions.
diff --git a/Magento2/Helpers/Commenting/PHPDocFormattingValidator.php b/Magento2/Helpers/Commenting/PHPDocFormattingValidator.php
@@ -122,13 +122,18 @@ 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;
+            if ($seeTagRequired) {
+                return false;
+            } else {
+                return true;
+            }
         }
         if ($tokens[$seePtr + 2]['code'] !== T_DOC_COMMENT_STRING) {
             return false;

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
      */