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

fabpot · fabpot · commit 91c342ffc992 · 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/Node/AttributeNode.php b/Node/AttributeNode.php
@@ -63,9 +63,6 @@ public function getValue(): ?string
         return $this->value;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getSpecificity(): Specificity
     {
         return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));
diff --git a/Node/ClassNode.php b/Node/ClassNode.php
@@ -42,9 +42,6 @@ public function getName(): string
         return $this->name;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getSpecificity(): Specificity
     {
         return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));
diff --git a/Node/CombinedSelectorNode.php b/Node/CombinedSelectorNode.php
@@ -49,9 +49,6 @@ public function getSubSelector(): NodeInterface
         return $this->subSelector;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getSpecificity(): Specificity
     {
         return $this->selector->getSpecificity()->plus($this->subSelector->getSpecificity());
diff --git a/Node/ElementNode.php b/Node/ElementNode.php
@@ -42,9 +42,6 @@ public function getElement(): ?string
         return $this->element;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getSpecificity(): Specificity
     {
         return new Specificity(0, 0, $this->element ? 1 : 0);
diff --git a/Node/FunctionNode.php b/Node/FunctionNode.php
@@ -57,9 +57,6 @@ public function getArguments(): array
         return $this->arguments;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getSpecificity(): Specificity
     {
         return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));
diff --git a/Node/HashNode.php b/Node/HashNode.php
@@ -42,9 +42,6 @@ public function getId(): string
         return $this->id;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getSpecificity(): Specificity
     {
         return $this->selector->getSpecificity()->plus(new Specificity(1, 0, 0));
diff --git a/Node/NegationNode.php b/Node/NegationNode.php
@@ -42,9 +42,6 @@ public function getSubSelector(): NodeInterface
         return $this->subSelector;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getSpecificity(): Specificity
     {
         return $this->selector->getSpecificity()->plus($this->subSelector->getSpecificity());
diff --git a/Node/PseudoNode.php b/Node/PseudoNode.php
@@ -42,9 +42,6 @@ public function getIdentifier(): string
         return $this->identifier;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getSpecificity(): Specificity
     {
         return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));
diff --git a/Node/SelectorNode.php b/Node/SelectorNode.php
@@ -42,9 +42,6 @@ public function getPseudoElement(): ?string
         return $this->pseudoElement;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getSpecificity(): Specificity
     {
         return $this->tree->getSpecificity()->plus(new Specificity(0, 0, $this->pseudoElement ? 1 : 0));
diff --git a/Parser/Handler/CommentHandler.php b/Parser/Handler/CommentHandler.php
@@ -26,9 +26,6 @@
  */
 class CommentHandler implements HandlerInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public function handle(Reader $reader, TokenStream $stream): bool
     {
         if ('/*' !== $reader->getSubstring(2)) {
diff --git a/Parser/Handler/HashHandler.php b/Parser/Handler/HashHandler.php
@@ -38,9 +38,6 @@ public function __construct(TokenizerPatterns $patterns, TokenizerEscaping $esca
         $this->escaping = $escaping;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handle(Reader $reader, TokenStream $stream): bool
     {
         $match = $reader->findPattern($this->patterns->getHashPattern());
diff --git a/Parser/Handler/IdentifierHandler.php b/Parser/Handler/IdentifierHandler.php
@@ -38,9 +38,6 @@ public function __construct(TokenizerPatterns $patterns, TokenizerEscaping $esca
         $this->escaping = $escaping;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handle(Reader $reader, TokenStream $stream): bool
     {
         $match = $reader->findPattern($this->patterns->getIdentifierPattern());
diff --git a/Parser/Handler/NumberHandler.php b/Parser/Handler/NumberHandler.php
@@ -35,9 +35,6 @@ public function __construct(TokenizerPatterns $patterns)
         $this->patterns = $patterns;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handle(Reader $reader, TokenStream $stream): bool
     {
         $match = $reader->findPattern($this->patterns->getNumberPattern());
diff --git a/Parser/Handler/StringHandler.php b/Parser/Handler/StringHandler.php
@@ -40,9 +40,6 @@ public function __construct(TokenizerPatterns $patterns, TokenizerEscaping $esca
         $this->escaping = $escaping;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function handle(Reader $reader, TokenStream $stream): bool
     {
         $quote = $reader->getSubstring(1);
diff --git a/Parser/Handler/WhitespaceHandler.php b/Parser/Handler/WhitespaceHandler.php
@@ -27,9 +27,6 @@
  */
 class WhitespaceHandler implements HandlerInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public function handle(Reader $reader, TokenStream $stream): bool
     {
         $match = $reader->findPattern('~^[ \t\r\n\f]+~');
diff --git a/Parser/Parser.php b/Parser/Parser.php
@@ -34,9 +34,6 @@ public function __construct(Tokenizer $tokenizer = null)
         $this->tokenizer = $tokenizer ?? new Tokenizer();
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function parse(string $source): array
     {
         $reader = new Reader($source);
diff --git a/Parser/Shortcut/ClassParser.php b/Parser/Shortcut/ClassParser.php
@@ -28,9 +28,6 @@
  */
 class ClassParser implements ParserInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public function parse(string $source): array
     {
         // Matches an optional namespace, optional element, and required class
diff --git a/Parser/Shortcut/ElementParser.php b/Parser/Shortcut/ElementParser.php
@@ -27,9 +27,6 @@
  */
 class ElementParser implements ParserInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public function parse(string $source): array
     {
         // Matches an optional namespace, required element or `*`
diff --git a/Parser/Shortcut/EmptyStringParser.php b/Parser/Shortcut/EmptyStringParser.php
@@ -31,9 +31,6 @@
  */
 class EmptyStringParser implements ParserInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public function parse(string $source): array
     {
         // Matches an empty string
diff --git a/Parser/Shortcut/HashParser.php b/Parser/Shortcut/HashParser.php
@@ -28,9 +28,6 @@
  */
 class HashParser implements ParserInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public function parse(string $source): array
     {
         // Matches an optional namespace, optional element, and required id
diff --git a/XPath/Extension/AbstractExtension.php b/XPath/Extension/AbstractExtension.php
@@ -23,41 +23,26 @@
  */
 abstract class AbstractExtension implements ExtensionInterface
 {
-    /**
-     * {@inheritdoc}
-     */
     public function getNodeTranslators(): array
     {
         return [];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getCombinationTranslators(): array
     {
         return [];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getFunctionTranslators(): array
     {
         return [];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getPseudoClassTranslators(): array
     {
         return [];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getAttributeMatchingTranslators(): array
     {
         return [];
diff --git a/XPath/Extension/AttributeMatchingExtension.php b/XPath/Extension/AttributeMatchingExtension.php
@@ -26,9 +26,6 @@
  */
 class AttributeMatchingExtension extends AbstractExtension
 {
-    /**
-     * {@inheritdoc}
-     */
     public function getAttributeMatchingTranslators(): array
     {
         return [
@@ -109,9 +106,6 @@ public function translateDifferent(XPathExpr $xpath, string $attribute, ?string
         ));
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getName(): string
     {
         return 'attribute-matching';
diff --git a/XPath/Extension/CombinationExtension.php b/XPath/Extension/CombinationExtension.php
@@ -25,9 +25,6 @@
  */
 class CombinationExtension extends AbstractExtension
 {
-    /**
-     * {@inheritdoc}
-     */
     public function getCombinationTranslators(): array
     {
         return [
@@ -61,9 +58,6 @@ public function translateIndirectAdjacent(XPathExpr $xpath, XPathExpr $combinedX
         return $xpath->join('/following-sibling::', $combinedXpath);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getName(): string
     {
         return 'combination';
diff --git a/XPath/Extension/FunctionExtension.php b/XPath/Extension/FunctionExtension.php
@@ -30,9 +30,6 @@
  */
 class FunctionExtension extends AbstractExtension
 {
-    /**
-     * {@inheritdoc}
-     */
     public function getFunctionTranslators(): array
     {
         return [
@@ -161,9 +158,6 @@ public function translateLang(XPathExpr $xpath, FunctionNode $function): XPathEx
         ));
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getName(): string
     {
         return 'function';
diff --git a/XPath/Extension/HtmlExtension.php b/XPath/Extension/HtmlExtension.php
@@ -36,9 +36,6 @@ public function __construct(Translator $translator)
             ->setFlag(NodeExtension::ATTRIBUTE_NAME_IN_LOWER_CASE, true);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getPseudoClassTranslators(): array
     {
         return [
@@ -53,9 +50,6 @@ public function getPseudoClassTranslators(): array
         ];
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getFunctionTranslators(): array
     {
         return [
@@ -177,9 +171,6 @@ public function translateVisited(XPathExpr $xpath): XPathExpr
         return $xpath->addCondition('0');
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getName(): string
     {
         return 'html';
diff --git a/XPath/Extension/NodeExtension.php b/XPath/Extension/NodeExtension.php
@@ -59,9 +59,6 @@ public function hasFlag(int $flag): bool
         return (bool) ($this->flags & $flag);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getNodeTranslators(): array
     {
         return [
@@ -182,9 +179,6 @@ public function translateElement(Node\ElementNode $node): XPathExpr
         return $xpath;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getName(): string
     {
         return 'node';
diff --git a/XPath/Extension/PseudoClassExtension.php b/XPath/Extension/PseudoClassExtension.php
@@ -26,9 +26,6 @@
  */
 class PseudoClassExtension extends AbstractExtension
 {
-    /**
-     * {@inheritdoc}
-     */
     public function getPseudoClassTranslators(): array
     {
         return [
@@ -112,9 +109,6 @@ public function translateEmpty(XPathExpr $xpath): XPathExpr
         return $xpath->addCondition('not(*) and not(string-length())');
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getName(): string
     {
         return 'pseudo-class';
diff --git a/XPath/Translator.php b/XPath/Translator.php
@@ -87,9 +87,6 @@ public static function getXpathLiteral(string $element): string
         return sprintf('concat(%s)', implode(', ', $parts));
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function cssToXPath(string $cssExpr, string $prefix = 'descendant-or-self::'): string
     {
         $selectors = $this->parseSelectors($cssExpr);
@@ -106,9 +103,6 @@ public function cssToXPath(string $cssExpr, string $prefix = 'descendant-or-self
         return implode(' | ', $selectors);
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function selectorToXPath(SelectorNode $selector, string $prefix = 'descendant-or-self::'): string
     {
         return ($prefix ?: '').$this->nodeToXPath($selector);

Original file line number	Diff line number	Diff line change
`@@ -63,9 +63,6 @@ public function getValue(): ?string`
`63`	`63`	`return $this->value;`
`64`	`64`	`}`
`65`	`65`
`66`		`- /**`
`67`		`- * {@inheritdoc}`
`68`		`- */`
`69`	`66`	`public function getSpecificity(): Specificity`
`70`	`67`	`{`
`71`	`68`	`return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));`
Original file line number	Diff line number	Diff line change
`@@ -42,9 +42,6 @@ public function getName(): string`
`42`	`42`	`return $this->name;`
`43`	`43`	`}`
`44`	`44`
`45`		`- /**`
`46`		`- * {@inheritdoc}`
`47`		`- */`
`48`	`45`	`public function getSpecificity(): Specificity`
`49`	`46`	`{`
`50`	`47`	`return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));`
Original file line number	Diff line number	Diff line change
`@@ -49,9 +49,6 @@ public function getSubSelector(): NodeInterface`
`49`	`49`	`return $this->subSelector;`
`50`	`50`	`}`
`51`	`51`
`52`		`- /**`
`53`		`- * {@inheritdoc}`
`54`		`- */`
`55`	`52`	`public function getSpecificity(): Specificity`
`56`	`53`	`{`
`57`	`54`	`return $this->selector->getSpecificity()->plus($this->subSelector->getSpecificity());`
Original file line number	Diff line number	Diff line change
`@@ -42,9 +42,6 @@ public function getElement(): ?string`
`42`	`42`	`return $this->element;`
`43`	`43`	`}`
`44`	`44`
`45`		`- /**`
`46`		`- * {@inheritdoc}`
`47`		`- */`
`48`	`45`	`public function getSpecificity(): Specificity`
`49`	`46`	`{`
`50`	`47`	`return new Specificity(0, 0, $this->element ? 1 : 0);`
Original file line number	Diff line number	Diff line change
`@@ -57,9 +57,6 @@ public function getArguments(): array`
`57`	`57`	`return $this->arguments;`
`58`	`58`	`}`
`59`	`59`
`60`		`- /**`
`61`		`- * {@inheritdoc}`
`62`		`- */`
`63`	`60`	`public function getSpecificity(): Specificity`
`64`	`61`	`{`
`65`	`62`	`return $this->selector->getSpecificity()->plus(new Specificity(0, 1, 0));`
Original file line number	Diff line number	Diff line change
`@@ -42,9 +42,6 @@ public function getId(): string`
`42`	`42`	`return $this->id;`
`43`	`43`	`}`
`44`	`44`
`45`		`- /**`
`46`		`- * {@inheritdoc}`
`47`		`- */`
`48`	`45`	`public function getSpecificity(): Specificity`
`49`	`46`	`{`
`50`	`47`	`return $this->selector->getSpecificity()->plus(new Specificity(1, 0, 0));`
Original file line number	Diff line number	Diff line change
`@@ -42,9 +42,6 @@ public function getSubSelector(): NodeInterface`
`42`	`42`	`return $this->subSelector;`
`43`	`43`	`}`
`44`	`44`
`45`		`- /**`
`46`		`- * {@inheritdoc}`
`47`		`- */`
`48`	`45`	`public function getSpecificity(): Specificity`
`49`	`46`	`{`
`50`	`47`	`return $this->selector->getSpecificity()->plus($this->subSelector->getSpecificity());`
Original file line number	Diff line number	Diff line change
`@@ -42,9 +42,6 @@ public function getPseudoElement(): ?string`
`42`	`42`	`return $this->pseudoElement;`
`43`	`43`	`}`
`44`	`44`
`45`		`- /**`
`46`		`- * {@inheritdoc}`
`47`		`- */`
`48`	`45`	`public function getSpecificity(): Specificity`
`49`	`46`	`{`
`50`	`47`	`return $this->tree->getSpecificity()->plus(new Specificity(0, 0, $this->pseudoElement ? 1 : 0));`
Original file line number	Diff line number	Diff line change
`@@ -26,9 +26,6 @@`
`26`	`26`	`*/`
`27`	`27`	`class CommentHandler implements HandlerInterface`
`28`	`28`	`{`
`29`		`- /**`
`30`		`- * {@inheritdoc}`
`31`		`- */`
`32`	`29`	`public function handle(Reader $reader, TokenStream $stream): bool`
`33`	`30`	`{`
`34`	`31`	`if ('/*' !== $reader->getSubstring(2)) {`