Enhancement: Enable no_superfluous_phpdoc_tags fixer (#525)

* Enhancement: Enable no_superfluous_phpdoc_tags fixer * Fix: Run php-cs-fixer * Fix: Remove useless DocBlocks
infection · Nov 1, 2018 · 2439066 · 2439066
1 parent e0253ba
commit 2439066
Show file tree

Hide file tree

Showing 104 changed files with 1 addition and 249 deletions.
diff --git a/.php_cs.dist b/.php_cs.dist
@@ -51,6 +51,7 @@ return \PhpCsFixer\Config::create()
         'native_function_invocation' => [
             'include' => ['@compiler_optimized']
         ],
+        'no_superfluous_phpdoc_tags' => true,
         'no_useless_else'=> true,
         'ordered_class_elements' => true,
         'ordered_imports' => true,

diff --git a/src/Command/InfectionCommand.php b/src/Command/InfectionCommand.php
@@ -290,8 +290,6 @@ protected function execute(InputInterface $input, OutputInterface $output)
     /**
      * Run configuration command if config does not exist
      *
-     * @param InputInterface $input
-     * @param OutputInterface $output
      *
      * @throws InfectionException
      */

diff --git a/src/Config/Guesser/SourceDirGuesser.php b/src/Config/Guesser/SourceDirGuesser.php
@@ -95,7 +95,6 @@ private function parsePsrSection(array $autoloadDirs): array
 
     /**
      * @param array|string $path
-     * @param array        $dirs
      */
     private function parsePath($path, array &$dirs): void
     {

diff --git a/src/Console/OutputFormatter/OutputFormatter.php b/src/Console/OutputFormatter/OutputFormatter.php
@@ -41,16 +41,11 @@ interface OutputFormatter
 {
     /**
      * Triggered when mutation testing is being started
-     *
-     * @param int $mutationCount
      */
     public function start(int $mutationCount);
 
     /**
      * Triggered each time mutation process is finished for one Mutant
-     *
-     * @param MutantProcessInterface $mutantProcess
-     * @param int $mutationCount
      */
     public function advance(MutantProcessInterface $mutantProcess, int $mutationCount);
 

diff --git a/src/Differ/Differ.php b/src/Differ/Differ.php
@@ -49,11 +49,6 @@ class Differ
      */
     private $differ;
 
-    /**
-     * Differ constructor.
-     *
-     * @param BaseDiffer $differ
-     */
     public function __construct(BaseDiffer $differ)
     {
         $this->differ = $differ;
@@ -66,8 +61,6 @@ public function __construct(BaseDiffer $differ)
      *
      * @param array|string $from
      * @param array|string $to
-     *
-     * @return string
      */
     public function diff($from, $to): string
     {

diff --git a/src/EventDispatcher/EventDispatcher.php b/src/EventDispatcher/EventDispatcher.php
@@ -68,8 +68,6 @@ public function addSubscriber(EventSubscriberInterface $eventSubscriber): void
     }
 
     /**
-     * @param string $eventName
-     *
      * @return callable[]
      */
     private function getListeners(string $eventName): array

diff --git a/src/EventDispatcher/EventDispatcherInterface.php b/src/EventDispatcher/EventDispatcherInterface.php
@@ -42,8 +42,6 @@ interface EventDispatcherInterface
 {
     /**
      * Dispatches an event
-     *
-     * @param mixed $event
      */
     public function dispatch($event);
 

diff --git a/src/Finder/AbstractExecutableFinder.php b/src/Finder/AbstractExecutableFinder.php
@@ -43,9 +43,6 @@ abstract class AbstractExecutableFinder
     abstract public function find(): string;
 
     /**
-     * @param array $probableNames
-     * @param array $extraDirectories
-     *
      * @return string|null
      */
     protected function searchNonExecutables(array $probableNames, array $extraDirectories = [])

diff --git a/src/Logger/DebugFileLogger.php b/src/Logger/DebugFileLogger.php
@@ -73,9 +73,6 @@ protected function getLogLines(): array
 
     /**
      * @param MutantProcessInterface[] $processes
-     * @param string $headlinePrefix
-     *
-     * @return string
      */
     private function convertProcess(array $processes, string $headlinePrefix): string
     {

diff --git a/src/Logger/TextFileLogger.php b/src/Logger/TextFileLogger.php
@@ -59,9 +59,6 @@ protected function getLogLines(): array
 
     /**
      * @param MutantProcessInterface[] $processes
-     * @param string $headlinePrefix
-     *
-     * @return string
      */
     private function getLogParts(array $processes, string $headlinePrefix): string
     {

diff --git a/src/Mutant/Generator/MutationsGenerator.php b/src/Mutant/Generator/MutationsGenerator.php
@@ -107,7 +107,6 @@ public function __construct(
 
     /**
      * @param bool $onlyCovered mutate only covered by tests lines of code
-     * @param string $filter
      * @param NodeVisitorAbstract[] $extraNodeVisitors
      *
      * @return Mutation[]
@@ -134,7 +133,6 @@ public function generate(bool $onlyCovered, string $filter = '', array $extraNod
     }
 
     /**
-     * @param SplFileInfo $file
      * @param bool $onlyCovered mutate only covered by tests lines of code
      * @param NodeVisitorAbstract[] $extraNodeVisitors extra visitors to influence to mutation collection process
      *

diff --git a/src/Mutant/MetricsCalculator.php b/src/Mutant/MetricsCalculator.php
@@ -151,8 +151,6 @@ public function collect(MutantProcessInterface $mutantProcess): void
 
     /**
      * Mutation Score Indicator (MSI)
-     *
-     * @return float
      */
     public function getMutationScoreIndicator(): float
     {
@@ -168,8 +166,6 @@ public function getMutationScoreIndicator(): float
 
     /**
      * Mutation coverage percentage
-     *
-     * @return float
      */
     public function getCoverageRate(): float
     {
@@ -196,41 +192,26 @@ public function getCoveredCodeMutationScoreIndicator(): float
         return $detectionRateTested;
     }
 
-    /**
-     * @return int
-     */
     public function getKilledCount(): int
     {
         return $this->killedCount;
     }
 
-    /**
-     * @return int
-     */
     public function getEscapedCount(): int
     {
         return $this->escapedCount;
     }
 
-    /**
-     * @return int
-     */
     public function getTimedOutCount(): int
     {
         return $this->timedOutCount;
     }
 
-    /**
-     * @return int
-     */
     public function getNotCoveredByTestsCount(): int
     {
         return $this->notCoveredByTestsCount;
     }
 
-    /**
-     * @return int
-     */
     public function getTotalMutantsCount(): int
     {
         return $this->totalMutantsCount;

diff --git a/src/Mutator/Arithmetic/Assignment.php b/src/Mutator/Arithmetic/Assignment.php
@@ -46,7 +46,6 @@ final class Assignment extends Mutator
     /**
      * Replaces "+=", "*=", ".=", and similar with a plain "="
      *
-     * @param Node $node
      *
      * @return Node\Expr\Assign
      */

diff --git a/src/Mutator/Arithmetic/AssignmentEqual.php b/src/Mutator/Arithmetic/AssignmentEqual.php
@@ -46,7 +46,6 @@ final class AssignmentEqual extends Mutator
     /**
      * Replaces "==" with "="
      *
-     * @param Node $node
      *
      * @return Node\Expr\Assign
      */

diff --git a/src/Mutator/Arithmetic/BitwiseAnd.php b/src/Mutator/Arithmetic/BitwiseAnd.php
@@ -46,7 +46,6 @@ final class BitwiseAnd extends Mutator
     /**
      * Replaces "&" with "|"
      *
-     * @param Node $node
      *
      * @return Node\Expr\BinaryOp\BitwiseOr
      */

diff --git a/src/Mutator/Arithmetic/BitwiseNot.php b/src/Mutator/Arithmetic/BitwiseNot.php
@@ -45,10 +45,6 @@ final class BitwiseNot extends Mutator
 {
     /**
      * Replaces "~" with "" (removed)
-     *
-     * @param Node $node
-     *
-     * @return mixed
      */
     public function mutate(Node $node)
     {

diff --git a/src/Mutator/Arithmetic/BitwiseOr.php b/src/Mutator/Arithmetic/BitwiseOr.php
@@ -46,7 +46,6 @@ final class BitwiseOr extends Mutator
     /**
      * Replaces "|" with "&"
      *
-     * @param Node $node
      *
      * @return Node\Expr\BinaryOp\BitwiseAnd
      */

diff --git a/src/Mutator/Arithmetic/BitwiseXor.php b/src/Mutator/Arithmetic/BitwiseXor.php
@@ -46,7 +46,6 @@ final class BitwiseXor extends Mutator
     /**
      * Replaces "^" with "&"
      *
-     * @param Node $node
      *
      * @return Node\Expr\BinaryOp\BitwiseAnd
      */

diff --git a/src/Mutator/Arithmetic/Decrement.php b/src/Mutator/Arithmetic/Decrement.php
@@ -50,7 +50,6 @@ final class Decrement extends Mutator
     /**
      * Replaces "--" with "++"
      *
-     * @param Node $node
      *
      * @return PreInc|PostInc
      */

diff --git a/src/Mutator/Arithmetic/DivEqual.php b/src/Mutator/Arithmetic/DivEqual.php
@@ -46,7 +46,6 @@ final class DivEqual extends Mutator
     /**
      * Replaces "/=" with "*="
      *
-     * @param Node $node
      *
      * @return Node\Expr\AssignOp\Mul
      */

diff --git a/src/Mutator/Arithmetic/Division.php b/src/Mutator/Arithmetic/Division.php
@@ -46,7 +46,6 @@ final class Division extends Mutator
     /**
      * Replaces "/" with "*"
      *
-     * @param Node $node
      *
      * @return Node\Expr\BinaryOp\Mul
      */

diff --git a/src/Mutator/Arithmetic/Exponentiation.php b/src/Mutator/Arithmetic/Exponentiation.php
@@ -46,7 +46,6 @@ final class Exponentiation extends Mutator
     /**
      * Replaces "**" with "/"
      *
-     * @param Node $node
      *
      * @return Node\Expr\BinaryOp\Div
      */

diff --git a/src/Mutator/Arithmetic/Increment.php b/src/Mutator/Arithmetic/Increment.php
@@ -50,7 +50,6 @@ final class Increment extends Mutator
     /**
      * Replaces "++" with "--"
      *
-     * @param Node $node
      *
      * @return PostDec|PreDec
      */

diff --git a/src/Mutator/Arithmetic/Minus.php b/src/Mutator/Arithmetic/Minus.php
@@ -46,7 +46,6 @@ final class Minus extends Mutator
     /**
      * Replaces "-" with "+"
      *
-     * @param Node $node
      *
      * @return Node\Expr\BinaryOp\Plus
      */

diff --git a/src/Mutator/Arithmetic/MinusEqual.php b/src/Mutator/Arithmetic/MinusEqual.php
@@ -46,7 +46,6 @@ final class MinusEqual extends Mutator
     /**
      * Replaces "-=" with "+="
      *
-     * @param Node $node
      *
      * @return Node\Expr\AssignOp\Plus
      */

diff --git a/src/Mutator/Arithmetic/ModEqual.php b/src/Mutator/Arithmetic/ModEqual.php
@@ -46,7 +46,6 @@ final class ModEqual extends Mutator
     /**
      * Replaces "%=" with "*="
      *
-     * @param Node $node
      *
      * @return Node\Expr\AssignOp\Mul
      */

diff --git a/src/Mutator/Arithmetic/Modulus.php b/src/Mutator/Arithmetic/Modulus.php
@@ -46,7 +46,6 @@ final class Modulus extends Mutator
     /**
      * Replaces "%" with "*"
      *
-     * @param Node $node
      *
      * @return Node\Expr\BinaryOp\Mul
      */

diff --git a/src/Mutator/Arithmetic/MulEqual.php b/src/Mutator/Arithmetic/MulEqual.php
@@ -46,7 +46,6 @@ final class MulEqual extends Mutator
     /**
      * Replaces "*=" with "/="
      *
-     * @param Node $node
      *
      * @return Node\Expr\AssignOp\Div
      */

diff --git a/src/Mutator/Arithmetic/Multiplication.php b/src/Mutator/Arithmetic/Multiplication.php
@@ -46,7 +46,6 @@ final class Multiplication extends Mutator
     /**
      * Replaces "*" with "/"
      *
-     * @param Node $node
      *
      * @return Node\Expr\BinaryOp\Div
      */

diff --git a/src/Mutator/Arithmetic/Plus.php b/src/Mutator/Arithmetic/Plus.php
@@ -47,7 +47,6 @@ final class Plus extends Mutator
     /**
      * Replaces "+" with "-"
      *
-     * @param Node $node
      *
      * @return Node\Expr\BinaryOp\Minus
      */

diff --git a/src/Mutator/Arithmetic/PlusEqual.php b/src/Mutator/Arithmetic/PlusEqual.php
@@ -46,7 +46,6 @@ final class PlusEqual extends Mutator
     /**
      * Replaces "+=" with "-="
      *
-     * @param Node $node
      *
      * @return Node\Expr\AssignOp\Minus
      */

diff --git a/src/Mutator/Arithmetic/PowEqual.php b/src/Mutator/Arithmetic/PowEqual.php
@@ -46,7 +46,6 @@ final class PowEqual extends Mutator
     /**
      * Replaces "**=" with "/="
      *
-     * @param Node $node
      *
      * @return Node\Expr\AssignOp\Div
      */

diff --git a/src/Mutator/Arithmetic/ShiftLeft.php b/src/Mutator/Arithmetic/ShiftLeft.php
@@ -46,7 +46,6 @@ final class ShiftLeft extends Mutator
     /**
      * Replaces "<<" with ">>"
      *
-     * @param Node $node
      *
      * @return Node\Expr\BinaryOp\ShiftRight
      */

diff --git a/src/Mutator/Arithmetic/ShiftRight.php b/src/Mutator/Arithmetic/ShiftRight.php
@@ -46,7 +46,6 @@ final class ShiftRight extends Mutator
     /**
      * Replaces ">>" with "<<"
      *
-     * @param Node $node
      *
      * @return Node\Expr\BinaryOp\ShiftLeft
      */

diff --git a/src/Mutator/Boolean/ArrayItem.php b/src/Mutator/Boolean/ArrayItem.php
@@ -46,7 +46,6 @@ final class ArrayItem extends Mutator
     /**
      * Replaces "[$a->foo => $b->bar]" with "[$a->foo > $b->bar]"
      *
-     * @param Node $node
      *
      * @return Node\Expr\BinaryOp\Greater
      */

diff --git a/src/Mutator/Boolean/EqualIdentical.php b/src/Mutator/Boolean/EqualIdentical.php
@@ -46,7 +46,6 @@ final class EqualIdentical extends Mutator
     /**
      * Replaces "==" with "==="
      *
-     * @param Node $node
      *
      * @return Node\Expr\BinaryOp\Identical
      */

diff --git a/src/Mutator/Boolean/FalseValue.php b/src/Mutator/Boolean/FalseValue.php
@@ -46,7 +46,6 @@ final class FalseValue extends Mutator
     /**
      * Replaces "false" with "true"
      *
-     * @param Node $node
      *
      * @return Node\Expr\ConstFetch
      */

diff --git a/src/Mutator/Boolean/IdenticalEqual.php b/src/Mutator/Boolean/IdenticalEqual.php
@@ -46,7 +46,6 @@ final class IdenticalEqual extends Mutator
     /**
      * Replaces "===" with "=="
      *
-     * @param Node $node
      *
      * @return Node\Expr\BinaryOp\Equal
      */