minor #47390 [CS] Remove @inheritdoc PHPDoc (lyrixx)

fabpot · fabpot · commit f6772df1ab85 · 2022-08-26T07:51:22.000+02:00
This PR was merged into the 6.2 branch. Discussion ---------- [CS] Remove `@inheritdoc` PHPDoc | Q | A | ------------- | --- | Branch? | 6.2 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | | License | MIT | Doc PR | --- It looks like this PHP Doc is useless. IDEs are able to inherit the doc (at least VS Code and PHP Storm). And tools like PHP Stan are able to too https://phpstan.org/r/74a2c008-ff2b-42c0-8edf-8da87c1a7b5f I could have open an RFC before doing the PR, but it was easy :) So let's discuss here Commits ------- 015d5015e3 [CS] Remove `@inheritdoc` PHPDoc
diff --git a/Test/Constraint/CrawlerSelectorAttributeValueSame.php b/Test/Constraint/CrawlerSelectorAttributeValueSame.php
@@ -27,18 +27,13 @@ public function __construct(string $selector, string $attribute, string $expecte
         $this->expectedText = $expectedText;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toString(): string
     {
         return sprintf('has a node matching selector "%s" with attribute "%s" of value "%s"', $this->selector, $this->attribute, $this->expectedText);
     }
 
     /**
      * @param Crawler $crawler
-     *
-     * {@inheritdoc}
      */
     protected function matches($crawler): bool
     {
@@ -52,8 +47,6 @@ protected function matches($crawler): bool
 
     /**
      * @param Crawler $crawler
-     *
-     * {@inheritdoc}
      */
     protected function failureDescription($crawler): string
     {
diff --git a/Test/Constraint/CrawlerSelectorExists.php b/Test/Constraint/CrawlerSelectorExists.php
@@ -23,18 +23,13 @@ public function __construct(string $selector)
         $this->selector = $selector;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toString(): string
     {
         return sprintf('matches selector "%s"', $this->selector);
     }
 
     /**
      * @param Crawler $crawler
-     *
-     * {@inheritdoc}
      */
     protected function matches($crawler): bool
     {
@@ -43,8 +38,6 @@ protected function matches($crawler): bool
 
     /**
      * @param Crawler $crawler
-     *
-     * {@inheritdoc}
      */
     protected function failureDescription($crawler): string
     {
diff --git a/Test/Constraint/CrawlerSelectorTextContains.php b/Test/Constraint/CrawlerSelectorTextContains.php
@@ -27,9 +27,6 @@ public function __construct(string $selector, string $expectedText)
         $this->expectedText = $expectedText;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toString(): string
     {
         if ($this->hasNode) {
@@ -41,8 +38,6 @@ public function toString(): string
 
     /**
      * @param Crawler $crawler
-     *
-     * {@inheritdoc}
      */
     protected function matches($crawler): bool
     {
@@ -61,8 +56,6 @@ protected function matches($crawler): bool
 
     /**
      * @param Crawler $crawler
-     *
-     * {@inheritdoc}
      */
     protected function failureDescription($crawler): string
     {
diff --git a/Test/Constraint/CrawlerSelectorTextSame.php b/Test/Constraint/CrawlerSelectorTextSame.php
@@ -25,18 +25,13 @@ public function __construct(string $selector, string $expectedText)
         $this->expectedText = $expectedText;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function toString(): string
     {
         return sprintf('has a node matching selector "%s" with content "%s"', $this->selector, $this->expectedText);
     }
 
     /**
      * @param Crawler $crawler
-     *
-     * {@inheritdoc}
      */
     protected function matches($crawler): bool
     {
@@ -50,8 +45,6 @@ protected function matches($crawler): bool
 
     /**
      * @param Crawler $crawler
-     *
-     * {@inheritdoc}
      */
     protected function failureDescription($crawler): string
     {

Original file line number	Diff line number	Diff line change
`@@ -27,18 +27,13 @@ public function __construct(string $selector, string $attribute, string $expecte`
`27`	`27`	`$this->expectedText = $expectedText;`
`28`	`28`	`}`
`29`	`29`
`30`		`- /**`
`31`		`- * {@inheritdoc}`
`32`		`- */`
`33`	`30`	`public function toString(): string`
`34`	`31`	`{`
`35`	`32`	`return sprintf('has a node matching selector "%s" with attribute "%s" of value "%s"', $this->selector, $this->attribute, $this->expectedText);`
`36`	`33`	`}`
`37`	`34`
`38`	`35`	`/**`
`39`	`36`	`* @param Crawler $crawler`
`40`		`- *`
`41`		`- * {@inheritdoc}`
`42`	`37`	`*/`
`43`	`38`	`protected function matches($crawler): bool`
`44`	`39`	`{`
`@@ -52,8 +47,6 @@ protected function matches($crawler): bool`
`52`	`47`
`53`	`48`	`/**`
`54`	`49`	`* @param Crawler $crawler`
`55`		`- *`
`56`		`- * {@inheritdoc}`
`57`	`50`	`*/`
`58`	`51`	`protected function failureDescription($crawler): string`
`59`	`52`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,18 +23,13 @@ public function __construct(string $selector)`
`23`	`23`	`$this->selector = $selector;`
`24`	`24`	`}`
`25`	`25`
`26`		`- /**`
`27`		`- * {@inheritdoc}`
`28`		`- */`
`29`	`26`	`public function toString(): string`
`30`	`27`	`{`
`31`	`28`	`return sprintf('matches selector "%s"', $this->selector);`
`32`	`29`	`}`
`33`	`30`
`34`	`31`	`/**`
`35`	`32`	`* @param Crawler $crawler`
`36`		`- *`
`37`		`- * {@inheritdoc}`
`38`	`33`	`*/`
`39`	`34`	`protected function matches($crawler): bool`
`40`	`35`	`{`
`@@ -43,8 +38,6 @@ protected function matches($crawler): bool`
`43`	`38`
`44`	`39`	`/**`
`45`	`40`	`* @param Crawler $crawler`
`46`		`- *`
`47`		`- * {@inheritdoc}`
`48`	`41`	`*/`
`49`	`42`	`protected function failureDescription($crawler): string`
`50`	`43`	`{`
Original file line number	Diff line number	Diff line change
`@@ -27,9 +27,6 @@ public function __construct(string $selector, string $expectedText)`
`27`	`27`	`$this->expectedText = $expectedText;`
`28`	`28`	`}`
`29`	`29`
`30`		`- /**`
`31`		`- * {@inheritdoc}`
`32`		`- */`
`33`	`30`	`public function toString(): string`
`34`	`31`	`{`
`35`	`32`	`if ($this->hasNode) {`
`@@ -41,8 +38,6 @@ public function toString(): string`
`41`	`38`
`42`	`39`	`/**`
`43`	`40`	`* @param Crawler $crawler`
`44`		`- *`
`45`		`- * {@inheritdoc}`
`46`	`41`	`*/`
`47`	`42`	`protected function matches($crawler): bool`
`48`	`43`	`{`
`@@ -61,8 +56,6 @@ protected function matches($crawler): bool`
`61`	`56`
`62`	`57`	`/**`
`63`	`58`	`* @param Crawler $crawler`
`64`		`- *`
`65`		`- * {@inheritdoc}`
`66`	`59`	`*/`
`67`	`60`	`protected function failureDescription($crawler): string`
`68`	`61`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,18 +25,13 @@ public function __construct(string $selector, string $expectedText)`
`25`	`25`	`$this->expectedText = $expectedText;`
`26`	`26`	`}`
`27`	`27`
`28`		`- /**`
`29`		`- * {@inheritdoc}`
`30`		`- */`
`31`	`28`	`public function toString(): string`
`32`	`29`	`{`
`33`	`30`	`return sprintf('has a node matching selector "%s" with content "%s"', $this->selector, $this->expectedText);`
`34`	`31`	`}`
`35`	`32`
`36`	`33`	`/**`
`37`	`34`	`* @param Crawler $crawler`
`38`		`- *`
`39`		`- * {@inheritdoc}`
`40`	`35`	`*/`
`41`	`36`	`protected function matches($crawler): bool`
`42`	`37`	`{`
`@@ -50,8 +45,6 @@ protected function matches($crawler): bool`
`50`	`45`
`51`	`46`	`/**`
`52`	`47`	`* @param Crawler $crawler`
`53`		`- *`
`54`		`- * {@inheritdoc}`
`55`	`48`	`*/`
`56`	`49`	`protected function failureDescription($crawler): string`
`57`	`50`	`{`