getDocComment() doesn't return string, per PhpParser code;

Author: ashnazg

src/phpDocumentor/Reflection/Php/Factory/ClassConstantIterator.php

@@ -73,10 +73,8 @@ public function getFqsen(): Fqsen
      * Gets the doc comment of the node.
      *
      * The doc comment has to be the last comment associated with the node.
-     *
-     * @return null|Doc Doc comment object or null
      */
-    public function getDocComment()
+    public function getDocComment(): ?Doc
     {
         $docComment = $this->classConstants->consts[$this->index]->getDocComment();
         if ($docComment === null) {

src/phpDocumentor/Reflection/Php/Factory/PropertyIterator.php

@@ -88,10 +88,8 @@ public function getLine(): int
      * Gets the doc comment of the node.
      *
      * The doc comment has to be the last comment associated with the node.
-     *
-     * @return null|Doc Doc comment object or null
      */
-    public function getDocComment()
+    public function getDocComment(): ?Doc
     {
         $docComment = $this->property->props[$this->index]->getDocComment();
         if ($docComment === null) {

tests/unit/phpDocumentor/Reflection/Php/Factory/ClassConstantIteratorTest.php

@@ -14,6 +14,7 @@
 
 use Mockery as m;
 use phpDocumentor\Reflection\Fqsen;
+use PhpParser\Comment\Doc;
 use PhpParser\Node\Const_;
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Stmt\ClassConst;
@@ -94,12 +95,12 @@ public function testGetDocCommentPropFirst()
         $classConstants = m::mock(ClassConst::class);
         $classConstants->consts = [$const];
 
-        $const->shouldReceive('getDocComment')->once()->andReturn('test');
+        $const->shouldReceive('getDocComment')->once()->andReturn(new Doc('test'));
         $classConstants->shouldReceive('getDocComment')->never();
 
         $fixture = new ClassConstantIterator($classConstants);
 
-        $this->assertEquals('test', $fixture->getDocComment());
+        $this->assertEquals('test', $fixture->getDocComment()->getText());
     }
 
     /**
@@ -112,10 +113,10 @@ public function testGetDocComment()
         $classConstants->consts = [$const];
 
         $const->shouldReceive('getDocComment')->once()->andReturnNull();
-        $classConstants->shouldReceive('getDocComment')->once()->andReturn('test');
+        $classConstants->shouldReceive('getDocComment')->once()->andReturn(new Doc('test'));
 
         $fixture = new ClassConstantIterator($classConstants);
 
-        $this->assertEquals('test', $fixture->getDocComment());
+        $this->assertEquals('test', $fixture->getDocComment()->getText());
     }
 }

tests/unit/phpDocumentor/Reflection/Php/Factory/PropertyIteratorTest.php

@@ -13,6 +13,7 @@
 namespace phpDocumentor\Reflection\Php\Factory;
 
 use Mockery as m;
+use PhpParser\Comment\Doc;
 use PhpParser\Node\Stmt\Property as PropertyNode;
 use PhpParser\Node\Stmt\PropertyProperty;
 use PHPUnit\Framework\TestCase;
@@ -114,12 +115,12 @@ public function testGetDocCommentPropFirst()
         $propertyNode = m::mock(PropertyNode::class);
         $propertyNode->props = [$prop];
 
-        $prop->shouldReceive('getDocComment')->once()->andReturn('test');
+        $prop->shouldReceive('getDocComment')->once()->andReturn(new Doc('test'));
         $propertyNode->shouldReceive('getDocComment')->never();
 
         $fixture = new PropertyIterator($propertyNode);
 
-        $this->assertEquals('test', $fixture->getDocComment());
+        $this->assertEquals('test', $fixture->getDocComment()->getText());
     }
 
     /**
@@ -132,10 +133,10 @@ public function testGetDocComment()
         $propertyNode->props = [$prop];
 
         $prop->shouldReceive('getDocComment')->once()->andReturnNull();
-        $propertyNode->shouldReceive('getDocComment')->once()->andReturn('test');
+        $propertyNode->shouldReceive('getDocComment')->once()->andReturn(new Doc('test'));
 
         $fixture = new PropertyIterator($propertyNode);
 
-        $this->assertEquals('test', $fixture->getDocComment());
+        $this->assertEquals('test', $fixture->getDocComment()->getText());
     }
 }