Merge pull request #144 from ashnazg/bug-63

Ellipsis in summary

Author: jaapio

src/DocBlockFactory.php

@@ -166,7 +166,7 @@ private function splitDocBlock(string $comment)
                 [^\n.]+
                 (?:
                   (?! \. \n | \n{2} )     # End summary upon a dot followed by newline or two newlines
-                  [\n.] (?! [ \t]* @\pL ) # End summary when an @ is found as first character on a new line
+                  [\n.]* (?! [ \t]* @\pL ) # End summary when an @ is found as first character on a new line
                   [^\n.]+                 # Include anything else
                 )*
                 \.?

tests/integration/InterpretingDocBlocksTest.php

@@ -33,6 +33,31 @@ public function tearDown(): void
         m::close();
     }
 
+    public function testInterpretingSummaryWithEllipsis(): void
+    {
+        $docblock = <<<DOCBLOCK
+/**
+ * This is a short (...) description.
+ *
+ * This is a long description.
+ *
+ * @return void
+ */
+DOCBLOCK;
+
+        $factory = DocBlockFactory::createInstance();
+        $phpdoc = $factory->create($docblock);
+
+        $summary = 'This is a short (...) description.';
+        $description = 'This is a long description.';
+
+        $this->assertInstanceOf(DocBlock::class, $phpdoc);
+        $this->assertSame($summary, $phpdoc->getSummary());
+        $this->assertSame($description, $phpdoc->getDescription()->render());
+        $this->assertCount(1, $phpdoc->getTags());
+        $this->assertTrue($phpdoc->hasTag('return'));
+    }
+
     public function testInterpretingASimpleDocBlock(): void
     {
         /**

tests/unit/DocBlockTest.php

@@ -48,6 +48,21 @@ public function testDocBlockCanHaveASummary(): void
         $this->assertSame($summary, $fixture->getSummary());
     }
 
+    /**
+     * @covers ::__construct
+     * @covers ::getSummary
+     *
+     * @uses \phpDocumentor\Reflection\DocBlock\Description
+     */
+    public function testDocBlockCanHaveEllipsisInSummary(): void
+    {
+        $summary = 'This is a short (...) description.';
+
+        $fixture = new DocBlock($summary);
+
+        $this->assertSame($summary, $fixture->getSummary());
+    }
+
     /**
      * @covers ::__construct
      * @covers ::getDescription