Merge pull request #14 from JeRabix/master

add support parse generic type in docBlock

phpunit.xml.dist

@@ -1,14 +1,13 @@
 <?xml version="1.0" encoding="utf-8"?>
-
-<phpunit colors="true" strict="true" bootstrap="vendor/autoload.php">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" bootstrap="vendor/autoload.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage>
+    <include>
+      <directory suffix=".php">./src/</directory>
+    </include>
+  </coverage>
   <testsuites>
     <testsuite name="phpDocumentor\Reflection\DocBlock">
       <directory>./tests/</directory>
     </testsuite>
   </testsuites>
-  <filter>
-    <whitelist>
-        <directory suffix=".php">./src/</directory>
-    </whitelist>
-  </filter>
 </phpunit>

src/Barryvdh/Reflection/DocBlock/Description.php

@@ -109,7 +109,7 @@ class Description implements \Reflector
                     )
                 \}/Sux',
                 $this->contents,
-                null,
+                -1,
                 PREG_SPLIT_DELIM_CAPTURE
             );
 

src/Barryvdh/Reflection/DocBlock/Tag.php

@@ -95,7 +95,9 @@ class Tag implements \Reflector
         'var'
             => '\Barryvdh\Reflection\DocBlock\Tag\VarTag',
         'version'
-            => '\Barryvdh\Reflection\DocBlock\Tag\VersionTag'
+            => '\Barryvdh\Reflection\DocBlock\Tag\VersionTag',
+        'SuppressWarnings'
+            => '\Barryvdh\Reflection\DocBlock\Tag\SuppressWarningsTag'
     );
 
     /**

src/Barryvdh/Reflection/DocBlock/Tag/ParamTag.php

@@ -53,6 +53,14 @@ class ParamTag extends ReturnTag
             PREG_SPLIT_DELIM_CAPTURE
         );
 
+        // detect generic type
+        if (isset($parts[0]) && isset($parts[2]) && strpos($parts[0], '<') !== false && strpos($parts[2], '>') !== false) {
+            $parts[0] .= ' ' . $parts[2];
+            unset($parts[1]);
+            unset($parts[2]);
+            $parts = array_values($parts);
+        }
+
         // if the first item that is encountered is not a variable; it is a type
         if (isset($parts[0])
             && (strlen($parts[0]) > 0)

src/Barryvdh/Reflection/DocBlock/Tag/SuppressWarningsTag.php

@@ -0,0 +1,30 @@
+<?php
+/**
+ * phpDocumentor
+ *
+ * PHP Version 5.3
+ *
+ * @author    Andrew Smith <[email protected]>
+ * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
+ * @license   http://www.opensource.org/licenses/mit-license.php MIT
+ * @link      http://phpdoc.org
+ */
+
+namespace Barryvdh\Reflection\DocBlock\Tag;
+
+use Barryvdh\Reflection\DocBlock\Tag;
+
+/**
+ * Reflection class for a @SuppressWarnings tag in a Docblock.
+ *
+ * @author  Andrew Smith <[email protected]>
+ * @license http://www.opensource.org/licenses/mit-license.php MIT
+ * @link    http://phpdoc.org
+ */
+class SuppressWarningsTag extends Tag
+{
+    public function __toString()
+    {
+        return "@{$this->getName()}{$this->getContent()}";
+    }
+}

tests/Barryvdh/Reflection/DocBlock/Tag/SuppressWarningsTagTest.php

@@ -0,0 +1,75 @@
+<?php
+/**
+ * phpDocumentor SuppressWarnings Tag Test
+ *
+ * PHP version 5.3
+ *
+ * @author    Andrew Smith <[email protected]>
+ * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
+ * @license   http://www.opensource.org/licenses/mit-license.php MIT
+ * @link      http://phpdoc.org
+ */
+
+namespace Barryvdh\Reflection\DocBlock\Tag;
+
+use PHPUnit\Framework\Test;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Test class for \Barryvdh\Reflection\DocBlock\Tag\SuppressWarningsTag
+ *
+ * @author    Andrew Smith <[email protected]>
+ * @copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
+ * @license   http://www.opensource.org/licenses/mit-license.php MIT
+ * @link      http://phpdoc.org
+ */
+class SuppressWarningsTagTest extends TestCase
+{
+    /**
+     * Test that the \Barryvdh\Reflection\DocBlock\Tag\SuppressWarningsTag can
+     * understand the @SuppressWarnings doc block.
+     *
+     * @param string $type
+     * @param string $content
+     * @param string $exType
+     * @param string $exVariable
+     * @param string $exDescription
+     *
+     * @covers \Barryvdh\Reflection\DocBlock\Tag\SuppressWarningsTag
+     * @dataProvider provideDataForConstuctor
+     *
+     * @return void
+     */
+    public function testConstructorParesInputsIntoCorrectFields(
+        $type,
+        $content,
+        $description
+    ) {
+        $tag = new SuppressWarningsTag($type, $content);
+
+        $this->assertEquals($type, $tag->getName());
+        $this->assertEquals($description, $tag->getDescription());
+    }
+
+    /**
+     * Data provider for testConstructorParesInputsIntoCorrectFields
+     *
+     * @return array
+     */
+    public function provideDataForConstuctor()
+    {
+        // $type, $content, $description
+        return array(
+            array(
+                'SuppressWarnings',
+                'SuppressWarnings(PHPMD)',
+                'SuppressWarnings(PHPMD)',
+            ),
+            array(
+                'SuppressWarnings',
+                'SuppressWarnings(PHPMD.TooManyMethods)',
+                'SuppressWarnings(PHPMD.TooManyMethods)',
+            ),
+        );
+    }
+}