Merge pull request #146 from allcode/bugfix/fix-wrong-docblock-return-types

Fixed docblock return types for 3.x releases

Author: weierophinney

src/Generator/ClassGenerator.php

@@ -743,7 +743,7 @@ public function addUse($use, $useAlias = null)
 
     /**
      * @param string $use
-     * @return self
+     * @return bool
      */
     public function hasUse($use)
     {

src/Generator/DocBlock/Tag/AbstractTypeableTag.php

@@ -50,7 +50,7 @@ public function __construct($types = [], $description = null)
 
     /**
      * @param string $description
-     * @return ReturnTag
+     * @return AbstractTypeableTag
      */
     public function setDescription($description)
     {
@@ -71,7 +71,7 @@ public function getDescription()
      * e.g. array('int', 'null') or "int|null"
      *
      * @param array|string $types
-     * @return ReturnTag
+     * @return AbstractTypeableTag
      */
     public function setTypes($types)
     {

src/Generator/DocBlock/Tag/AuthorTag.php

@@ -42,7 +42,7 @@ public function __construct($authorName = null, $authorEmail = null)
 
     /**
      * @param ReflectionTagInterface $reflectionTag
-     * @return ReturnTag
+     * @return AuthorTag
      * @deprecated Deprecated in 2.3. Use TagManager::createTagFromReflection() instead
      */
     public static function fromReflection(ReflectionTagInterface $reflectionTag)

src/Generator/DocBlock/Tag/ParamTag.php

@@ -37,7 +37,7 @@ public function __construct($variableName = null, $types = [], $description = nu
 
     /**
      * @param ReflectionTagInterface $reflectionTag
-     * @return ReturnTag
+     * @return ParamTag
      * @deprecated Deprecated in 2.3. Use TagManager::createTagFromReflection() instead
      */
     public static function fromReflection(ReflectionTagInterface $reflectionTag)
@@ -75,7 +75,7 @@ public function getVariableName()
 
     /**
      * @param string $datatype
-     * @return ReturnTag
+     * @return ParamTag
      * @deprecated Deprecated in 2.3. Use setTypes() instead
      */
     public function setDatatype($datatype)

src/Generator/DocBlockGenerator.php

@@ -49,6 +49,9 @@ class DocBlockGenerator extends AbstractGenerator
      */
     protected $wordwrap = true;
 
+    /**
+     * @var TagManager
+     */
     protected static $tagManager;
 
     /**
@@ -107,6 +110,9 @@ public static function fromArray(array $array)
         return $docBlock;
     }
 
+    /**
+     * @return TagManager
+     */
     protected static function getTagManager()
     {
         if (! isset(static::$tagManager)) {

src/Reflection/ClassReflection.php

@@ -50,7 +50,7 @@ public function getDeclaringFile()
     /**
      * Return the classes DocBlock reflection object
      *
-     * @return DocBlockReflection
+     * @return DocBlockReflection|false
      * @throws Exception\ExceptionInterface for missing DocBock or invalid reflection class
      */
     public function getDocBlock()
@@ -70,7 +70,7 @@ public function getDocBlock()
 
     /**
      * @param  AnnotationManager $annotationManager
-     * @return AnnotationCollection
+     * @return AnnotationCollection|false
      */
     public function getAnnotations(AnnotationManager $annotationManager)
     {
@@ -188,7 +188,7 @@ public function getMethods($filter = -1)
     /**
      * Returns an array of reflection classes of traits used by this class.
      *
-     * @return void|array
+     * @return null|array
      */
     public function getTraits()
     {

src/Reflection/DocBlock/Tag/MethodTag.php

@@ -78,7 +78,7 @@ public function initialize($tagDocblockLine)
     /**
      * Get return value type
      *
-     * @return void|string
+     * @return null|string
      * @deprecated 2.0.4 use getTypes instead
      */
     public function getReturnType()

src/Reflection/DocBlock/Tag/PropertyTag.php

@@ -64,7 +64,7 @@ public function initialize($tagDocblockLine)
     }
 
     /**
-     * @return void|string
+     * @return null|string
      * @deprecated 2.0.4 use getTypes instead
      */
     public function getType()

src/Reflection/DocBlockReflection.php

@@ -91,7 +91,6 @@ public static function export()
      * @param  Reflector|string $commentOrReflector
      * @param  null|DocBlockTagManager $tagManager
      * @throws Exception\InvalidArgumentException
-     * @return DocBlockReflection
      */
     public function __construct($commentOrReflector, DocBlockTagManager $tagManager = null)
     {

src/Reflection/FileReflection.php

@@ -158,7 +158,7 @@ public function getDocComment()
     }
 
     /**
-     * @return DocBlockReflection
+     * @return DocBlockReflection|false
      */
     public function getDocBlock()
     {
@@ -180,7 +180,7 @@ public function getNamespaces()
     }
 
     /**
-     * @return void|string
+     * @return null|string
      */
     public function getNamespace()
     {

src/Reflection/FunctionReflection.php

@@ -132,7 +132,7 @@ public function getContents($includeDocBlock = true)
      * Get method prototype
      *
      * @param string $format
-     * @return array
+     * @return array|string
      */
     public function getPrototype($format = FunctionReflection::PROTOTYPE_AS_ARRAY)
     {

src/Reflection/MethodReflection.php

@@ -64,7 +64,7 @@ public function getDocBlock()
 
     /**
      * @param  AnnotationManager $annotationManager
-     * @return AnnotationScanner
+     * @return AnnotationScanner|false
      */
     public function getAnnotations(AnnotationManager $annotationManager)
     {
@@ -123,7 +123,7 @@ public function getDeclaringClass()
      * Get method prototype
      *
      * @param string $format
-     * @return array
+     * @return array|string
      */
     public function getPrototype($format = MethodReflection::PROTOTYPE_AS_ARRAY)
     {

src/Reflection/ParameterReflection.php

@@ -37,13 +37,13 @@ public function getDeclaringClass()
     /**
      * Get class reflection object
      *
-     * @return void|ClassReflection
+     * @return null|ClassReflection
      */
     public function getClass()
     {
         $phpReflection = parent::getClass();
         if ($phpReflection === null) {
-            return;
+            return null;
         }
 
         $zendReflection = new ClassReflection($phpReflection->getName());

src/Reflection/PropertyReflection.php

@@ -64,7 +64,7 @@ public function getDocBlock()
 
     /**
      * @param  AnnotationManager $annotationManager
-     * @return AnnotationScanner
+     * @return AnnotationScanner|false
      */
     public function getAnnotations(AnnotationManager $annotationManager)
     {

src/Scanner/MethodScanner.php

@@ -189,7 +189,7 @@ public function getDocComment()
 
     /**
      * @param  AnnotationManager $annotationManager
-     * @return AnnotationScanner
+     * @return AnnotationScanner|false
      */
     public function getAnnotations(AnnotationManager $annotationManager)
     {

src/Scanner/PropertyScanner.php

@@ -211,7 +211,7 @@ public function getDocComment()
 
     /**
      * @param Annotation\AnnotationManager $annotationManager
-     * @return AnnotationScanner
+     * @return AnnotationScanner|false
      */
     public function getAnnotations(Annotation\AnnotationManager $annotationManager)
     {

src/Scanner/TokenArrayScanner.php

@@ -76,7 +76,7 @@ public function getAnnotationManager()
      * @todo Assignment of $this->docComment should probably be done in scan()
      *       and then $this->getDocComment() just retrieves it.
      *
-     * @return string
+     * @return string|null
      */
     public function getDocComment()
     {
@@ -176,7 +176,7 @@ public function getClasses()
      *
      * @param  string|int $name
      * @throws Exception\InvalidArgumentException
-     * @return ClassScanner
+     * @return ClassScanner|false
      */
     public function getClass($name)
     {
@@ -663,7 +663,7 @@ public function hasNamespace($namespace)
 
     /**
      * @param  string $namespace
-     * @return void|array
+     * @return null|array
      * @throws Exception\InvalidArgumentException
      */
     protected function getUsesNoScan($namespace)