💄 Clean comment and typing

Author: VincentLanglet

TwigCS/Config/Config.php

@@ -11,8 +11,6 @@
 class Config
 {
     /**
-     * Default configuration.
-     *
      * @var array
      */
     public static $defaultConfig = [
@@ -23,8 +21,6 @@ class Config
     ];
 
     /**
-     * Current configuration.
-     *
      * @var array
      */
     protected $config;
@@ -38,8 +34,6 @@ public function __construct(array $config = [])
     }
 
     /**
-     * Find all files to process, based on a file or directory and exclude patterns.
-     *
      * @return Finder
      *
      * @throws Exception
@@ -75,8 +69,6 @@ public function findFiles(): Finder
     }
 
     /**
-     * Get a configuration value for the given $key.
-     *
      * @param string $key
      *
      * @return mixed

TwigCS/Report/SniffViolation.php

@@ -16,43 +16,31 @@ class SniffViolation
     const LEVEL_FATAL   = 'FATAL';
 
     /**
-     * Level of the message among `notice`, `warning`, `error`
-     *
      * @var int
      */
     protected $level;
 
     /**
-     * Text message associated with the violation.
-     *
      * @var string
      */
     protected $message;
 
     /**
-     * Line number for the violation.
-     *
      * @var int|null
      */
     protected $line;
 
     /**
-     * Position of the violation on the current line.
-     *
      * @var int|null
      */
     protected $linePosition;
 
     /**
-     * File in which the violation has been found.
-     *
      * @var string
      */
     protected $filename;
 
     /**
-     * Sniff that has produce this violation.
-     *
      * @var SniffInterface|null
      */
     protected $sniff;
@@ -75,8 +63,6 @@ public function __construct(int $level, string $message, string $filename, int $
     }
 
     /**
-     * Get the level of this violation.
-     *
      * @return int
      */
     public function getLevel(): int
@@ -85,8 +71,6 @@ public function getLevel(): int
     }
 
     /**
-     * Get a human-readable of the level of this violation.
-     *
      * @return string
      */
     public function getLevelAsString(): string
@@ -106,8 +90,6 @@ public function getLevelAsString(): string
     }
 
     /**
-     * Get the integer value for a given string $level.
-     *
      * @param string $level
      *
      * @return int
@@ -129,8 +111,6 @@ public static function getLevelAsInt(string $level): int
     }
 
     /**
-     * Get the text message of this violation.
-     *
      * @return string
      */
     public function getMessage(): string
@@ -139,8 +119,6 @@ public function getMessage(): string
     }
 
     /**
-     * Get the line number where this violation occured.
-     *
      * @return int|null
      */
     public function getLine(): ?int
@@ -149,8 +127,6 @@ public function getLine(): ?int
     }
 
     /**
-     * Get the filename (and path) where this violation occured.
-     *
      * @return string
      */
     public function getFilename(): string
@@ -159,8 +135,6 @@ public function getFilename(): string
     }
 
     /**
-     * Set the position in the line where this violation occured.
-     *
      * @param int|null $linePosition
      *
      * @return self
@@ -173,8 +147,6 @@ public function setLinePosition(?int $linePosition): SniffViolation
     }
 
     /**
-     * Get the position in the line, if any.
-     *
      * @return int|null
      */
     public function getLinePosition(): ?int
@@ -183,8 +155,6 @@ public function getLinePosition(): ?int
     }
 
     /**
-     * Set the sniff that was not met.
-     *
      * @param SniffInterface $sniff
      *
      * @return self
@@ -197,8 +167,6 @@ public function setSniff(SniffInterface $sniff): SniffViolation
     }
 
     /**
-     * Get the sniff that was not met.
-     *
      * @return SniffInterface|null
      */
     public function getSniff(): ?SniffInterface

TwigCS/Report/TextFormatter.php

@@ -19,8 +19,6 @@ class TextFormatter
     const ERROR_LINE_WIDTH    = 120;
 
     /**
-     * Input-output helper object.
-     *
      * @var SymfonyStyle
      */
     protected $io;

TwigCS/Ruleset/Ruleset.php

@@ -38,8 +38,6 @@ public function addSniff(SniffInterface $sniff): Ruleset
     }
 
     /**
-     * Create a new set of rule.
-     *
      * @param string $standardName
      *
      * @return Ruleset

TwigCS/Runner/Fixer.php

@@ -14,15 +14,11 @@
 class Fixer
 {
     /**
-     * The number of times we have looped over a file.
-     *
      * @var int
      */
     protected $loops = 0;
 
     /**
-     * The character used when we are adding new lines.
-     *
      * @var string
      */
     protected $eolChar = "\n";
@@ -40,19 +36,19 @@ class Fixer
     /**
      * The list of tokens that make up the file contents.
      *
-     * This is a simplified list which just contains the token content and nothing
-     * else. This is the array that is updated as fixes are made, not the file's
-     * token array. Imploding this array will give you the file content back.
+     * This is a simplified list which just contains the token content and nothing else.
+     * This is the array that is updated as fixes are made, not the file's token array.
+     * Imploding this array will give you the file content back.
      *
-     * @var array<int, string>
+     * @var array
      */
     protected $tokens = [];
 
     /**
      * A list of tokens that have already been fixed.
      *
-     * We don't allow the same token to be fixed more than once each time
-     * through a file as this can easily cause conflicts between sniffs.
+     * We don't allow the same token to be fixed more than once each time through a file
+     * as this can easily cause conflicts between sniffs.
      *
      * @var int[]
      */
@@ -61,18 +57,16 @@ class Fixer
     /**
      * The last value of each fixed token.
      *
-     * If a token is being "fixed" back to its last value, the fix is
-     * probably conflicting with another.
+     * If a token is being "fixed" back to its last value, the fix is probably conflicting with another.
      *
-     * @var array<int, string>
+     * @var array
      */
     protected $oldTokenValues = [];
 
     /**
      * A list of tokens that have been fixed during a changeset.
      *
-     * All changes in changeset must be able to be applied, or else
-     * the entire changeset is rejected.
+     * All changes in changeset must be able to be applied, or else the entire changeset is rejected.
      *
      * @var array
      */
@@ -100,8 +94,6 @@ class Fixer
     protected $numFixes = 0;
 
     /**
-     * Starts fixing a new file.
-     *
      * @param Ruleset   $ruleset
      * @param Tokenizer $tokenizer
      *
@@ -134,8 +126,6 @@ public function startFile(array $tokens): void
     }
 
     /**
-     * Attempt to fix the file by processing it until no fixes are made.
-     *
      * @param string $file
      *
      * @return bool
@@ -181,8 +171,6 @@ public function fixFile(string $file): bool
     }
 
     /**
-     * Generates a text diff of the original file and the new content.
-     *
      * @param string $filePath File path to diff the file against.
      *
      * @return string
@@ -242,8 +230,6 @@ public function generateDiff(string $filePath): string
     }
 
     /**
-     * Get the current content of the file, as a string.
-     *
      * @return string
      */
     public function getContents(): string
@@ -254,12 +240,10 @@ public function getContents(): string
     }
 
     /**
-     * Get the current fixed content of a token.
-     *
      * This function takes changesets into account so should be used
      * instead of directly accessing the token array.
      *
-     * @param int $tokenPosition The position of the token in the token stack.
+     * @param int $tokenPosition
      *
      * @return string
      */
@@ -331,12 +315,10 @@ public function rollbackChangeset(): void
     }
 
     /**
-     * Replace the entire contents of a token.
+     * @param int    $tokenPosition
+     * @param string $content
      *
-     * @param int    $tokenPosition The position of the token in the token stack.
-     * @param string $content       The new content of the token.
-     *
-     * @return bool If the change was accepted.
+     * @return bool
      */
     public function replaceToken(int $tokenPosition, string $content): bool
     {
@@ -384,11 +366,9 @@ public function replaceToken(int $tokenPosition, string $content): bool
     }
 
     /**
-     * Reverts the previous fix made to a token.
+     * @param int $tokenPosition
      *
-     * @param int $tokenPosition The position of the token in the token stack.
-     *
-     * @return bool If a change was reverted.
+     * @return bool
      */
     public function revertToken(int $tokenPosition): bool
     {
@@ -404,11 +384,9 @@ public function revertToken(int $tokenPosition): bool
     }
 
     /**
-     * Adds a newline to end of a token's content.
-     *
-     * @param int $tokenPosition The position of the token in the token stack.
+     * @param int $tokenPosition
      *
-     * @return bool If the change was accepted.
+     * @return bool
      */
     public function addNewline(int $tokenPosition): bool
     {
@@ -418,11 +396,9 @@ public function addNewline(int $tokenPosition): bool
     }
 
     /**
-     * Adds a newline to the start of a token's content.
-     *
-     * @param int $tokenPosition The position of the token in the token stack.
+     * @param int $tokenPosition
      *
-     * @return bool If the change was accepted.
+     * @return bool
      */
     public function addNewlineBefore(int $tokenPosition): bool
     {
@@ -432,12 +408,10 @@ public function addNewlineBefore(int $tokenPosition): bool
     }
 
     /**
-     * Adds content to the end of a token's current content.
-     *
-     * @param int    $tokenPosition The position of the token in the token stack.
-     * @param string $content       The content to add.
+     * @param int    $tokenPosition
+     * @param string $content
      *
-     * @return bool If the change was accepted.
+     * @return bool
      */
     public function addContent(int $tokenPosition, string $content): bool
     {
@@ -447,12 +421,10 @@ public function addContent(int $tokenPosition, string $content): bool
     }
 
     /**
-     * Adds content to the start of a token's current content.
+     * @param int    $tokenPosition
+     * @param string $content
      *
-     * @param int    $tokenPosition The position of the token in the token stack.
-     * @param string $content       The content to add.
-     *
-     * @return bool If the change was accepted.
+     * @return bool
      */
     public function addContentBefore(int $tokenPosition, string $content): bool
     {