Merge pull request #130 from phpDocumentor/feature/never_type

Add support for never keyword

Author: jaapio

src/TypeResolver.php

@@ -107,6 +107,7 @@ final class TypeResolver
         'static' => Types\Static_::class,
         'parent' => Types\Parent_::class,
         'iterable' => Types\Iterable_::class,
+        'never' => Types\Never_::class,
     ];
 
     /**

src/Types/Never_.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @link      http://phpdoc.org
+ */
+
+namespace phpDocumentor\Reflection\Types;
+
+use phpDocumentor\Reflection\Type;
+
+/**
+ * Value Object representing the return-type 'never'.
+ *
+ * Never is generally only used when working with return types as it signifies that the method that only
+ * ever throw or exit.
+ *
+ * @psalm-immutable
+ */
+final class Never_ implements Type
+{
+    /**
+     * Returns a rendered output of the Type as it would be used in a DocBlock.
+     */
+    public function __toString(): string
+    {
+        return 'never';
+    }
+}

src/Types/Void_.php

@@ -16,7 +16,7 @@
 use phpDocumentor\Reflection\Type;
 
 /**
- * Value Object representing the pseudo-type 'void'.
+ * Value Object representing the return-type 'void'.
  *
  * Void is generally only used when working with return types as it signifies that the method intentionally does not
  * return any value.

tests/unit/TypeResolverTest.php

@@ -757,6 +757,7 @@ public function provideKeywords(): array
             ['self', Types\Self_::class],
             ['parent', Types\Parent_::class],
             ['iterable', Types\Iterable_::class],
+            ['never', Types\Never_::class],
         ];
     }