Exclude {@internal} comments from description

Author: afilina

src/Parser/SniffParser.php

@@ -142,8 +142,9 @@ private function getDocBlock(string $docComment): string
 
         $docBlockSummary = $docBlock->getSummary();
         $docBlockDescription = (string)$docBlock->getDescription();
+        $docBlockDescription = preg_replace('`\n*{@internal[^}]+}`', '', $docBlockDescription);
 
-        return $docBlockSummary . ($docBlockDescription !== '' ? "\n\n" . $docBlock->getDescription() : '');
+        return $docBlockSummary . ($docBlockDescription !== '' ? "\n\n" . $docBlockDescription : '');
     }
 
     /**

tests/Parser/SniffParserTest.php

@@ -294,6 +294,29 @@ class MySniff {}
         );
     }
 
+    /** @test */
+    public function parse_WithInternalDocblock_ExcludeInternal()
+    {
+        $content = '<?php
+        namespace Standard\Sniffs\Category;
+        /**
+         * Summary
+         *
+         * Description
+         * {@internal Multiline
+         * internal comment}
+         */
+        class MySniff {}
+        ';
+
+        (new Filesystem())->dumpFile(self::PHP_FILE_PATH, $content);
+        $doc = $this->parser->parse(self::PHP_FILE_PATH, new StringSourceLocator($content, $this->astLocator));
+        self::assertEquals(
+            "Summary\n\nDescription",
+            $doc->getDocblock()
+        );
+    }
+
     /** @test */
     public function parse_WithInvalidPhpPath_ThrowException()
     {