magento#162: @deprecated without @see tag false positive

lenaorobei · lenaorobei · commit 4bd41131fbb5 · 2020-09-02T15:46:15.000-05:00
- simplified logic
diff --git a/Magento2/Helpers/Commenting/PHPDocFormattingValidator.php b/Magento2/Helpers/Commenting/PHPDocFormattingValidator.php
@@ -126,16 +126,11 @@ public function hasDeprecatedWellFormatted($commentStartPtr, $tokens)
         if ($tokens[$deprecatedPtr + 2]['code'] !== T_DOC_COMMENT_STRING) {
             $seeTagRequired = true;
         }
-
         $seePtr = $this->getTagPosition('@see', $commentStartPtr, $tokens);
         if ($seePtr === -1) {
             return !$seeTagRequired;
         }
-        if ($tokens[$seePtr + 2]['code'] !== T_DOC_COMMENT_STRING) {
-            return false;
-        }
-
-        return true;
+        return $tokens[$seePtr + 2]['code'] === T_DOC_COMMENT_STRING;
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -126,16 +126,11 @@ public function hasDeprecatedWellFormatted($commentStartPtr, $tokens)`
`126`	`126`	`if ($tokens[$deprecatedPtr + 2]['code'] !== T_DOC_COMMENT_STRING) {`
`127`	`127`	`$seeTagRequired = true;`
`128`	`128`	`}`
`129`		`-`
`130`	`129`	`$seePtr = $this->getTagPosition('@see', $commentStartPtr, $tokens);`
`131`	`130`	`if ($seePtr === -1) {`
`132`	`131`	`return !$seeTagRequired;`
`133`	`132`	`}`
`134`		`- if ($tokens[$seePtr + 2]['code'] !== T_DOC_COMMENT_STRING) {`
`135`		`- return false;`
`136`		`- }`
`137`		`-`
`138`		`- return true;`
	`133`	`+ return $tokens[$seePtr + 2]['code'] === T_DOC_COMMENT_STRING;`
`139`	`134`	`}`
`140`	`135`
`141`	`136`	`/**`