Minor documentation fixes

... picked up along the way.

Author: jrfnl

scripts/ValidatePEAR/FileList.php

@@ -79,7 +79,7 @@ public function __construct($directory, $rootPath='', $filter='')
 
 
     /**
-     * Retrieve the filter file list as an array.
+     * Retrieve the filtered file list as an array.
      *
      * @return array
      */

src/Runner.php

@@ -230,7 +230,7 @@ public function runPHPCBF()
 
 
     /**
-     * Exits if the minimum requirements of PHP_CodSniffer are not met.
+     * Exits if the minimum requirements of PHP_CodeSniffer are not met.
      *
      * @return array
      * @throws \PHP_CodeSniffer\Exceptions\DeepExitException

src/Sniffs/AbstractVariableSniff.php

@@ -64,7 +64,7 @@ public function __construct()
 
 
     /**
-     * Processes the token in the specified PHP_CodeSniffer_File.
+     * Processes the token in the specified PHP_CodeSniffer\Files\File.
      *
      * @param \PHP_CodeSniffer\Files\File $phpcsFile The PHP_CodeSniffer file where this
      *                                               token was found.
@@ -92,7 +92,7 @@ final protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $cu
             return;
         }
 
-        // If this token is inside nested inside a function at a deeper
+        // If this token is nested inside a function at a deeper
         // level than the current OO scope that was found, it's a normal
         // variable and not a member var.
         $conditions = array_reverse($tokens[$stackPtr]['conditions'], true);
@@ -119,7 +119,7 @@ final protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $cu
         if ($inFunction === false && isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
             foreach ($tokens[$stackPtr]['nested_parenthesis'] as $opener => $closer) {
                 if (isset($tokens[$opener]['parenthesis_owner']) === false) {
-                    // Check if this is a USE statement in a closure.
+                    // Check if this is a USE statement for a closure.
                     $prev = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($opener - 1), null, true);
                     if ($tokens[$prev]['code'] === T_USE) {
                         $inFunction = true;

src/Standards/Generic/Sniffs/Functions/FunctionCallArgumentSpacingSniff.php

@@ -72,7 +72,7 @@ public function process(File $phpcsFile, $stackPtr)
         }
 
         // If the next non-whitespace token after the function or method call
-        // is not an opening parenthesis then it cant really be a *call*.
+        // is not an opening parenthesis then it can't really be a *call*.
         $openBracket = $phpcsFile->findNext(Tokens::$emptyTokens, ($functionName + 1), null, true);
         if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) {
             return;

src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php

@@ -548,7 +548,7 @@ protected function processParams(File $phpcsFile, $stackPtr, $commentStart)
             // Check number of spaces after the var name.
             $this->checkSpacingAfterParamName($phpcsFile, $param, $maxVar);
 
-            // Param comments must start with a capital letter and end with the full stop.
+            // Param comments must start with a capital letter and end with a full stop.
             if (preg_match('/^(\p{Ll}|\P{L})/u', $param['comment']) === 1) {
                 $error = 'Parameter comment must start with a capital letter';
                 $phpcsFile->addError($error, $param['tag'], 'ParamCommentNotCapital');

src/Standards/Squiz/Sniffs/Commenting/InlineCommentSniff.php

@@ -133,8 +133,8 @@ public function process(File $phpcsFile, $stackPtr)
             }
         }
 
-        // We don't want end of block comments. If the last comment is a closing
-        // curly brace.
+        // We don't want end of block comments. Check if the last token before the
+        // comment is a closing curly brace.
         $previousContent = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);
         if ($tokens[$previousContent]['line'] === $tokens[$stackPtr]['line']) {
             if ($tokens[$previousContent]['code'] === T_CLOSE_CURLY_BRACKET) {

src/Standards/Squiz/Sniffs/WhiteSpace/SuperfluousWhitespaceSniff.php

@@ -228,7 +228,7 @@ public function process(File $phpcsFile, $stackPtr)
                 && $tokens[($stackPtr - 1)]['line'] < $tokens[$stackPtr]['line']
                 && $tokens[($stackPtr - 2)]['line'] === $tokens[($stackPtr - 1)]['line']
             ) {
-                // Spacing around properties and functions in nested classes has their own rules.
+                // Properties and functions in nested classes have their own rules for spacing.
                 $conditions   = $tokens[$stackPtr]['conditions'];
                 $deepestScope = end($conditions);
                 if ($deepestScope === T_ANON_CLASS) {

src/Util/Common.php

@@ -384,9 +384,9 @@ public static function isUnderscoreName($string)
 
 
     /**
-     * Returns a valid variable type for param/var tag.
+     * Returns a valid variable type for param/var tags.
      *
-     * If type is not one of the standard type, it must be a custom type.
+     * If type is not one of the standard types, it must be a custom type.
      * Returns the correct type name suggestion if type name is invalid.
      *
      * @param string $varType The variable type to process.