Merge pull request #167 from MidnightDesign/remove-doc-block

Allow removing the doc block of a member

Author: michalbundyra

src/Generator/AbstractMemberGenerator.php

@@ -36,7 +36,7 @@ abstract class AbstractMemberGenerator extends AbstractGenerator
     /**#@-*/
 
     /**
-     * @var DocBlockGenerator
+     * @var DocBlockGenerator|null
      */
     protected $docBlock;
 
@@ -236,8 +236,13 @@ public function setDocBlock($docBlock)
         return $this;
     }
 
+    public function removeDocBlock(): void
+    {
+        $this->docBlock = null;
+    }
+
     /**
-     * @return DocBlockGenerator
+     * @return DocBlockGenerator|null
      */
     public function getDocBlock()
     {

test/Generator/AbstractMemberGeneratorTest.php

@@ -11,6 +11,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Zend\Code\Generator\AbstractMemberGenerator;
+use Zend\Code\Generator\DocBlockGenerator;
 use Zend\Code\Generator\Exception\InvalidArgumentException;
 
 class AbstractMemberGeneratorTest extends TestCase
@@ -43,4 +44,21 @@ public function testSetDocBlockThrowsExceptionWithInvalidType()
         $this->expectException(InvalidArgumentException::class);
         $this->fixture->setDocBlock(new \stdClass());
     }
+
+    public function testRemoveDocBlock(): void
+    {
+        $this->fixture->setDocBlock(new DocBlockGenerator());
+
+        $this->fixture->removeDocBlock();
+
+        $this->assertNull($this->fixture->getDocBlock());
+    }
+
+    public function testRemoveDocBlockIsIdempotent(): void
+    {
+        $this->fixture->removeDocBlock();
+        $this->fixture->removeDocBlock();
+
+        $this->assertNull($this->fixture->getDocBlock());
+    }
 }