Updated docs

Nyholm · Nyholm · commit e54cb6b47bfe · 2023-11-29T12:35:09.000+01:00
diff --git a/src/Symfony/Component/PropertyInfo/Extractor/PhpDocExtractor.php b/src/Symfony/Component/PropertyInfo/Extractor/PhpDocExtractor.php
@@ -225,8 +225,6 @@ private function filterDocBlockParams(DocBlock $docBlock, string $allowedParam):
     }
 
     /**
-     * Gets a property DocBlock.
-     *
      * @return array{DocBlock|null, int|null, string|null}
      */
     private function findDocBlock(string $class, string $property): array
diff --git a/src/Symfony/Component/PropertyInfo/PropertyDocBlockExtractorInterface.php b/src/Symfony/Component/PropertyInfo/PropertyDocBlockExtractorInterface.php
@@ -26,9 +26,9 @@ interface PropertyDocBlockExtractorInterface
     /**
      * Gets the first available doc block for a property. It finds the doc block
      * by the following priority:
-     * - constructor promoted argument
-     * - the class property
-     * - a mutator method for that property
+     *  - constructor promoted argument
+     *  - the class property
+     *  - a mutator method for that property
      *
      * If no doc block is found, it will return null.
      */
diff --git a/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpDocExtractorTest.php b/src/Symfony/Component/PropertyInfo/Tests/Extractor/PhpDocExtractorTest.php
@@ -39,21 +39,21 @@ protected function setUp(): void
      */
     public function testExtract($property, ?array $type, $shortDescription, $longDescription)
     {
-        $this->assertEquals($type, $this->extractor->getTypes('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', $property));
-        $this->assertSame($shortDescription, $this->extractor->getShortDescription('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', $property));
-        $this->assertSame($longDescription, $this->extractor->getLongDescription('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', $property));
+        $this->assertEquals($type, $this->extractor->getTypes(Dummy::class, $property));
+        $this->assertSame($shortDescription, $this->extractor->getShortDescription(Dummy::class, $property));
+        $this->assertSame($longDescription, $this->extractor->getLongDescription(Dummy::class, $property));
     }
 
     public function testGetDocBlock()
     {
-        $docBlock = $this->extractor->getDocBlock('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', 'g');
+        $docBlock = $this->extractor->getDocBlock(Dummy::class, 'g');
         $this->assertInstanceOf(DocBlock::class, $docBlock);
         $this->assertSame('Nullable array.', $docBlock->getSummary());
 
-        $docBlock = $this->extractor->getDocBlock('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', 'noDocBlock;');
+        $docBlock = $this->extractor->getDocBlock(Dummy::class, 'noDocBlock;');
         $this->assertNull($docBlock);
 
-        $docBlock = $this->extractor->getDocBlock('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', 'notAvailable');
+        $docBlock = $this->extractor->getDocBlock(Dummy::class, 'notAvailable');
         $this->assertNull($docBlock);
     }
 
@@ -89,7 +89,7 @@ public function testExtractTypesWithNoPrefixes($property, array $type = null)
     {
         $noPrefixExtractor = new PhpDocExtractor(null, [], [], []);
 
-        $this->assertEquals($type, $noPrefixExtractor->getTypes('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', $property));
+        $this->assertEquals($type, $noPrefixExtractor->getTypes(Dummy::class, $property));
     }
 
     public static function typesProvider()
@@ -211,7 +211,7 @@ public function testExtractTypesWithCustomPrefixes($property, array $type = null
     {
         $customExtractor = new PhpDocExtractor(null, ['add', 'remove'], ['is', 'can']);
 
-        $this->assertEquals($type, $customExtractor->getTypes('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', $property));
+        $this->assertEquals($type, $customExtractor->getTypes(Dummy::class, $property));
     }
 
     public static function typesWithCustomPrefixesProvider()

Original file line number	Diff line number	Diff line change
`@@ -225,8 +225,6 @@ private function filterDocBlockParams(DocBlock $docBlock, string $allowedParam):`
`225`	`225`	`}`
`226`	`226`
`227`	`227`	`/**`
`228`		`- * Gets a property DocBlock.`
`229`		`- *`
`230`	`228`	`* @return array{DocBlock\|null, int\|null, string\|null}`
`231`	`229`	`*/`
`232`	`230`	`private function findDocBlock(string $class, string $property): array`
Original file line number	Diff line number	Diff line change
`@@ -39,21 +39,21 @@ protected function setUp(): void`
`39`	`39`	`*/`
`40`	`40`	`public function testExtract($property, ?array $type, $shortDescription, $longDescription)`
`41`	`41`	`{`
`42`		`- $this->assertEquals($type, $this->extractor->getTypes('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', $property));`
`43`		`- $this->assertSame($shortDescription, $this->extractor->getShortDescription('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', $property));`
`44`		`- $this->assertSame($longDescription, $this->extractor->getLongDescription('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', $property));`
	`42`	`+ $this->assertEquals($type, $this->extractor->getTypes(Dummy::class, $property));`
	`43`	`+ $this->assertSame($shortDescription, $this->extractor->getShortDescription(Dummy::class, $property));`
	`44`	`+ $this->assertSame($longDescription, $this->extractor->getLongDescription(Dummy::class, $property));`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`public function testGetDocBlock()`
`48`	`48`	`{`
`49`		`- $docBlock = $this->extractor->getDocBlock('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', 'g');`
	`49`	`+ $docBlock = $this->extractor->getDocBlock(Dummy::class, 'g');`
`50`	`50`	`$this->assertInstanceOf(DocBlock::class, $docBlock);`
`51`	`51`	`$this->assertSame('Nullable array.', $docBlock->getSummary());`
`52`	`52`
`53`		`- $docBlock = $this->extractor->getDocBlock('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', 'noDocBlock;');`
	`53`	`+ $docBlock = $this->extractor->getDocBlock(Dummy::class, 'noDocBlock;');`
`54`	`54`	`$this->assertNull($docBlock);`
`55`	`55`
`56`		`- $docBlock = $this->extractor->getDocBlock('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', 'notAvailable');`
	`56`	`+ $docBlock = $this->extractor->getDocBlock(Dummy::class, 'notAvailable');`
`57`	`57`	`$this->assertNull($docBlock);`
`58`	`58`	`}`
`59`	`59`
`@@ -89,7 +89,7 @@ public function testExtractTypesWithNoPrefixes($property, array $type = null)`
`89`	`89`	`{`
`90`	`90`	`$noPrefixExtractor = new PhpDocExtractor(null, [], [], []);`
`91`	`91`
`92`		`- $this->assertEquals($type, $noPrefixExtractor->getTypes('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', $property));`
	`92`	`+ $this->assertEquals($type, $noPrefixExtractor->getTypes(Dummy::class, $property));`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`public static function typesProvider()`
`@@ -211,7 +211,7 @@ public function testExtractTypesWithCustomPrefixes($property, array $type = null`
`211`	`211`	`{`
`212`	`212`	`$customExtractor = new PhpDocExtractor(null, ['add', 'remove'], ['is', 'can']);`
`213`	`213`
`214`		`- $this->assertEquals($type, $customExtractor->getTypes('Symfony\Component\PropertyInfo\Tests\Fixtures\Dummy', $property));`
	`214`	`+ $this->assertEquals($type, $customExtractor->getTypes(Dummy::class, $property));`
`215`	`215`	`}`
`216`	`216`
`217`	`217`	`public static function typesWithCustomPrefixesProvider()`