use of PHPDocFormattingValidator

Author: konarshankar07

Magento2/Sniffs/Commenting/ClassPropertyPHPDocFormattingSniff.php

@@ -3,6 +3,7 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\AbstractVariableSniff;
+use PHP_CodeSniffer\Util\Tokens;
 
 /**
  * Class ClassPropertyPHPDocFormattingSniff
@@ -22,6 +23,28 @@ class ClassPropertyPHPDocFormattingSniff extends AbstractVariableSniff
         T_WHITESPACE,
     ];
 
+    /**
+     * @var PHPDocFormattingValidator
+     */
+    private $PHPDocFormattingValidator;
+
+    /**
+     * Constructs an AbstractVariableTest.
+     */
+    public function __construct()
+    {
+        $scopes = Tokens::$ooScopeTokens;
+        $this->PHPDocFormattingValidator = new PHPDocFormattingValidator();
+        $listen = [
+            T_VARIABLE,
+            T_DOUBLE_QUOTED_STRING,
+            T_HEREDOC,
+        ];
+
+        parent::__construct($scopes, $listen, true);
+
+    }
+
     /**
      * @param File $phpcsFile
      * @param int $stackPtr
@@ -39,9 +62,7 @@ public function processMemberVar(File $phpcsFile, $stackPtr)
             $phpcsFile->addWarning('Missing class property doc comment', $stackPtr, 'Missing');
             return;
         }
-
         $commentStart = $tokens[$commentEnd]['comment_opener'];
-
         $foundVar = null;
         foreach ($tokens[$commentStart]['comment_tags'] as $tag) {
             if ($tokens[$tag]['content'] === '@var') {
@@ -69,9 +90,9 @@ public function processMemberVar(File $phpcsFile, $stackPtr)
 
         // Check if class has already have meaningful description
         $isShortDescription = $phpcsFile->findPrevious(T_DOC_COMMENT_STRING, $commentEnd, $foundVar, false);
-        if ($tokens[$string]['line'] !==  $tokens[$isShortDescription]['line']) {
+        if ($this->PHPDocFormattingValidator->providesMeaning($isShortDescription, $commentStart, $tokens) !== true) {
             $error = 'Variable member already have meaningful name';
-            $phpcsFile->addWarning($error, $isShortDescription, 'AlreadyMeaningFulNameVar');
+            $phpcsFile->addWarning($error, $isShortDescription, 'AlreadyHaveMeaningFulNameVar');
             return;
         }
     }

Magento2/Tests/Commenting/ClassPropertyPHPDocFormattingUnitTest.php

@@ -26,11 +26,11 @@ public function getWarningList()
             13 => 1,
             18 => 1,
             23 => 1,
-            30 => 2,
+            30 => 1,
             34 => 1,
             42 => 1,
             49 => 1,
-            56 => 1
+            56 => 1,
         ];
     }
 }