Minor other documentation fixes

PHPCompatibility/Sniff.php

@@ -256,7 +256,7 @@ public function stringToErrorCode($baseString)
     /**
      * Strip quotes surrounding an arbitrary string.
      *
-     * Intended for use with the content of a T_CONSTANT_ENCAPSED_STRING / T_DOUBLE_QUOTED_STRING.
+     * Intended for use with the contents of a T_CONSTANT_ENCAPSED_STRING / T_DOUBLE_QUOTED_STRING.
      *
      * @param string $string The raw string.
      *
@@ -271,7 +271,7 @@ public function stripQuotes($string)
     /**
      * Strip variables from an arbitrary double quoted string.
      *
-     * Intended for use with the content of a T_DOUBLE_QUOTED_STRING.
+     * Intended for use with the contents of a T_DOUBLE_QUOTED_STRING.
      *
      * @param string $string The raw string.
      *

PHPCompatibility/Sniffs/PHP/ForbiddenCallTimePassByReferenceSniff.php

@@ -40,7 +40,7 @@ class ForbiddenCallTimePassByReferenceSniff extends Sniff
      * @var array
      */
     private $assignOrCompare = array(
-        // Comparison tokens.
+        // Equality tokens.
         'T_IS_EQUAL'            => true,
         'T_IS_NOT_EQUAL'        => true,
         'T_IS_IDENTICAL'        => true,
@@ -226,7 +226,7 @@ protected function isCallTimePassByReferenceParam(\PHP_CodeSniffer_File $phpcsFi
 
         } while ($nextVariable < $searchEndToken);
 
-        // This code should never be reached, but here in case of weird bugs ;-)
+        // This code should never be reached, but here in case of weird bugs.
         return false;
     }
 

PHPCompatibility/Sniffs/PHP/NewKeywordsSniff.php

@@ -356,9 +356,9 @@ protected function filterErrorData(array $data, array $itemInfo, array $errorInf
      * A double quoted identifier will have the opening quote on position 3
      * in the string: `<<<"ID"`.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
-     * @param int                  $stackPtr  The position of the current token in
-     *                                        the stack passed in $tokens.
+     * @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
+     * @param int                   $stackPtr  The position of the current token in
+     *                                         the stack passed in $tokens.
      *
      * @return bool
      */

PHPCompatibility/Sniffs/PHP/RemovedFunctionParametersSniff.php

@@ -195,7 +195,7 @@ protected function getErrorMsgTemplate()
 
 
     /**
-     * Allow for concrete child classes to filter the error data before it's passed to PHPCS.
+     * Filter the error data before it's passed to PHPCS.
      *
      * @param array $data      The error data array which was created.
      * @param array $itemInfo  Base information about the item this error message applies to.

PHPCompatibility/Tests/BaseClass/IsNumberTest.php

@@ -37,7 +37,7 @@ class IsNumberTest extends MethodTestFrame
      * @covers \PHPCompatibility\Sniff::isPositiveNumber
      * @covers \PHPCompatibility\Sniff::isNegativeNumber
      *
-     * @param string     $commentString    The commentwhich prefaces the target snippet in the test file.
+     * @param string     $commentString    The comment which prefaces the target snippet in the test file.
      * @param bool       $allowFloats      Testing the snippets for integers only or floats as well ?
      * @param float|bool $isNumber         The expected return value for isNumber().
      * @param bool       $isPositiveNumber The expected return value for isPositiveNumber().

PHPCompatibility/Tests/BaseClass/TestHelperPHPCompatibility.php

@@ -50,9 +50,7 @@ public function process(\PHP_CodeSniffer_File $phpcsFile, $stackPtr)
      *                                           token will be examined as part of the snippet.
      * @param bool                  $allowFloats Whether to only consider integers, or also floats.
      *
-     * @return float|bool The number found if PHP would evaluate the snippet as a number.
-     *                    False if not or if it could not be reliably determined
-     *                    (variable or calculations and such).
+     * @return int|float|bool
      */
     public function isNumber(\PHP_CodeSniffer_File $phpcsFile, $start, $end, $allowFloats = false)
     {

PHPCompatibility/Tests/BaseSniffTest.php

@@ -28,7 +28,7 @@ class BaseSniffTest extends \PHPUnit_Framework_TestCase
      *
      * Used by PHPCS 1.x and 2.x.
      *
-     * @var PHP_CodeSniffer
+     * @var \PHP_CodeSniffer
      */
     protected static $phpcs = null;
 

PHPCompatibility/Tests/Sniffs/PHP/NewFunctionParametersSniffTest.php

@@ -34,7 +34,7 @@ class NewFunctionParametersSniffTest extends BaseSniffTest
      * @param string $functionName      Function name.
      * @param string $parameterName     Parameter name.
      * @param string $lastVersionBefore The PHP version just *before* the parameter was introduced.
-     * @param array  $lines             The line numbers in the test file which apply to this class.
+     * @param array  $lines             The line numbers in the test file which apply to this function parameter.
      * @param string $okVersion         A PHP version in which the parameter was ok to be used.
      * @param string $testVersion       Optional PHP version to use for testing the flagged case.
      *

PHPCompatibility/Tests/sniff-examples/utility-functions/is_number.php

@@ -34,7 +34,7 @@
 $a = '10 things' . ' or nothing';
 
 /*
- * Make sure that zeo numbers are correctly identified.
+ * Make sure that zero numbers are correctly identified.
  *
  * The below should be recognized as numbers (integers).
  */