handle case with tags, no description

Author: udovicic

Magento2/Sniffs/Commenting/PHPDocFormattingValidator.php

@@ -24,6 +24,9 @@ public function providesMeaning($namePtr, $commentStartPtr, $tokens)
         $commentCloserPtr = $tokens[$commentStartPtr]['comment_closer'];
         $name = strtolower(str_replace([' ', '"', '_'], '', $tokens[$namePtr]['content']));
 
+        $hasTags = false;
+        $hasDescription = false;
+
         for ($i = $commentStartPtr; $i <= $commentCloserPtr; $i++) {
             $token = $tokens[$i];
 
@@ -34,9 +37,12 @@ public function providesMeaning($namePtr, $commentStartPtr, $tokens)
 
             // Wrong kind of string
             if ($tokens[$i - 2]['code'] === T_DOC_COMMENT_TAG) {
+                $hasTags = true;
                 continue;
             }
 
+            $hasDescription = true;
+
             // Comment is the same as the origin name
             $docComment = str_replace(['_', ' ', '.', ','], '', strtolower($token['content']));
             if ($docComment === $name) {
@@ -53,6 +59,11 @@ public function providesMeaning($namePtr, $commentStartPtr, $tokens)
             return true;
         }
 
+        // Contains nothing but the tags
+        if ($hasTags === true && $hasDescription === false) {
+            return true;
+        }
+
         return false;
     }
 }

Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.1.inc

@@ -67,4 +67,13 @@ class EmptyHandler
 class ExampleHandler
 {
 
+}
+
+/**
+ * @api
+ * @since 100.0.2
+ */
+class ApiHandler
+{
+
 }

Magento2/Tests/Commenting/ClassAndInterfacePHPDocFormattingUnitTest.2.inc

@@ -67,4 +67,13 @@ interface EmptyHandler
 interface ExampleHandler
 {
 
+}
+
+/**
+ * @api
+ * @since 100.0.2
+ */
+interface ApiHandler
+{
+
 }