Feedback changes

Author: konarshankar07

Magento2/Sniffs/Commenting/ClassPropertyPHPDocFormattingSniff.php

@@ -88,11 +88,30 @@ public function processMemberVar(File $phpcsFile, $stackPtr)
             return;
         }
 
-        // Check if class has already have meaningful description
-        $isShortDescription = $phpcsFile->findPrevious(T_DOC_COMMENT_STRING, $commentEnd, $foundVar, false);
-        if ($this->PHPDocFormattingValidator->providesMeaning($isShortDescription, $commentStart, $tokens) !== true) {
+        // Check if class has already have meaningful description after @var tag
+        $isShortDescriptionAfterVar = $phpcsFile->findNext(T_DOC_COMMENT_STRING, $foundVar + 4, $commentEnd, false,
+            null,
+            false);
+        if ($this->PHPDocFormattingValidator->providesMeaning($isShortDescriptionAfterVar, $commentStart, $tokens) !== true) {
+            preg_match('`^((?:\|?(?:array\([^\)]*\)|[\\\\\[\]]+))*)( .*)?`i', $tokens[($foundVar + 2)]['content'], $varParts);
+            if ($varParts[1]) {
+                return;
+            }
+            $error = 'Short description duplicates class property name.';
+            $phpcsFile->addWarning($error, $isShortDescriptionAfterVar, 'AlreadyHaveMeaningFulNameVar');
+            return;
+        }
+        // Check if class has already have meaningful description before @var tag
+        $isShortDescriptionPreviousVar = $phpcsFile->findPrevious(T_DOC_COMMENT_STRING, $foundVar, $commentStart, false,
+            null,
+            false);
+        if ($this->PHPDocFormattingValidator->providesMeaning($isShortDescriptionPreviousVar, $commentStart, $tokens) !== true) {
+            preg_match('`^((?:\|?(?:array\([^\)]*\)|[\\\\\[\]]+))*)( .*)?`i', $tokens[($foundVar + 2)]['content'], $varParts);
+            if ($varParts[1]) {
+                return;
+            }
             $error = 'Short description duplicates class property name.';
-            $phpcsFile->addWarning($error, $isShortDescription, 'AlreadyHaveMeaningFulNameVar');
+            $phpcsFile->addWarning($error, $isShortDescriptionPreviousVar, 'AlreadyHaveMeaningFulNameVar');
             return;
         }
     }

Magento2/Tests/Commenting/ClassPropertyPHPDocFormattingUnitTest.inc

@@ -63,6 +63,13 @@ class Bar {
      * Variable name
      */
     private $variableName;
+
+    /**
+     * Some more invalid description
+     *
+     * @var test
+     */
+    protected $test;
 }
 
 class correctlyFormattedClassMemberDocBlock
@@ -81,4 +88,15 @@ class correctlyFormattedClassMemberDocBlock
      * @var correctlyFormattedProtectedClassMember
      */
     protected $correctlyFormattedProtectedClassMember;
+
+    /**
+     * @var Array|\Foo_BAR
+     */
+    protected $array;
+
+    /**
+     * @var \FOO\BAR\TEST\Class\\FooBarInterface|
+     *      \FooObject_TEST_C
+     */
+    private $testObject;
 }

Magento2/Tests/Commenting/ClassPropertyPHPDocFormattingUnitTest.php

@@ -31,7 +31,8 @@ public function getWarningList()
             42 => 1,
             49 => 1,
             56 => 1,
-            63 => 1
+            63 => 1,
+            68 => 1
         ];
     }
 }