Various documentation fixes

... collected along the way.

Author: jrfnl

src/Files/File.php

@@ -1370,7 +1370,7 @@ public function getMethodParameters($stackPtr)
             case T_SELF:
             case T_PARENT:
             case T_STATIC:
-                // Self is valid, the others invalid, but were probably intended as type hints.
+                // Self and parent are valid, static invalid, but was probably intended as type hint.
                 if (isset($defaultStart) === false) {
                     if ($typeHintToken === false) {
                         $typeHintToken = $i;
@@ -1945,10 +1945,10 @@ public function isReference($stackPtr)
      * Returns the content of the tokens from the specified start position in
      * the token stack for the specified length.
      *
-     * @param int $start       The position to start from in the token stack.
-     * @param int $length      The length of tokens to traverse from the start pos.
-     * @param int $origContent Whether the original content or the tab replaced
-     *                         content should be used.
+     * @param int  $start       The position to start from in the token stack.
+     * @param int  $length      The length of tokens to traverse from the start pos.
+     * @param bool $origContent Whether the original content or the tab replaced
+     *                          content should be used.
      *
      * @return string The token contents.
      */

src/Sniffs/AbstractScopeSniff.php

@@ -11,7 +11,7 @@
  *         parent::__construct(array(T_CLASS), array(T_FUNCTION));
  *     }
  *
- *     protected function processTokenWithinScope(\PHP_CodeSniffer\Files\File $phpcsFile, $)
+ *     protected function processTokenWithinScope(\PHP_CodeSniffer\Files\File $phpcsFile, $stackPtr, $currScope)
  *     {
  *         $className = $phpcsFile->getDeclarationName($currScope);
  *         echo 'encountered a method within class '.$className;
@@ -123,7 +123,7 @@ final public function register()
      *
      * @return void|int Optionally returns a stack pointer. The sniff will not be
      *                  called again on the current file until the returned stack
-     *                  pointer is reached. Return (count($tokens) + 1) to skip
+     *                  pointer is reached. Return ($phpcsFile->numTokens + 1) to skip
      *                  the rest of the file.
      * @see    processTokenWithinScope()
      */
@@ -166,7 +166,7 @@ final public function process(File $phpcsFile, $stackPtr)
      *
      * @return void|int Optionally returns a stack pointer. The sniff will not be
      *                  called again on the current file until the returned stack
-     *                  pointer is reached. Return (count($tokens) + 1) to skip
+     *                  pointer is reached. Return ($phpcsFile->numTokens + 1) to skip
      *                  the rest of the file.
      */
     abstract protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope);

src/Sniffs/AbstractVariableSniff.php

@@ -73,7 +73,7 @@ public function __construct()
      *
      * @return void|int Optionally returns a stack pointer. The sniff will not be
      *                  called again on the current file until the returned stack
-     *                  pointer is reached. Return (count($tokens) + 1) to skip
+     *                  pointer is reached. Return ($phpcsFile->numTokens + 1) to skip
      *                  the rest of the file.
      */
     final protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope)
@@ -157,7 +157,7 @@ final protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $cu
      *
      * @return void|int Optionally returns a stack pointer. The sniff will not be
      *                  called again on the current file until the returned stack
-     *                  pointer is reached. Return (count($tokens) + 1) to skip
+     *                  pointer is reached. Return ($phpcsFile->numTokens + 1) to skip
      *                  the rest of the file.
      */
     final protected function processTokenOutsideScope(File $phpcsFile, $stackPtr)
@@ -188,7 +188,7 @@ final protected function processTokenOutsideScope(File $phpcsFile, $stackPtr)
      *
      * @return void|int Optionally returns a stack pointer. The sniff will not be
      *                  called again on the current file until the returned stack
-     *                  pointer is reached. Return (count($tokens) + 1) to skip
+     *                  pointer is reached. Return ($phpcsFile->numTokens + 1) to skip
      *                  the rest of the file.
      */
     abstract protected function processMemberVar(File $phpcsFile, $stackPtr);
@@ -203,7 +203,7 @@ abstract protected function processMemberVar(File $phpcsFile, $stackPtr);
      *
      * @return void|int Optionally returns a stack pointer. The sniff will not be
      *                  called again on the current file until the returned stack
-     *                  pointer is reached. Return (count($tokens) + 1) to skip
+     *                  pointer is reached. Return ($phpcsFile->numTokens + 1) to skip
      *                  the rest of the file.
      */
     abstract protected function processVariable(File $phpcsFile, $stackPtr);
@@ -222,7 +222,7 @@ abstract protected function processVariable(File $phpcsFile, $stackPtr);
      *
      * @return void|int Optionally returns a stack pointer. The sniff will not be
      *                  called again on the current file until the returned stack
-     *                  pointer is reached. Return (count($tokens) + 1) to skip
+     *                  pointer is reached. Return ($phpcsFile->numTokens + 1) to skip
      *                  the rest of the file.
      */
     abstract protected function processVariableInString(File $phpcsFile, $stackPtr);

src/Standards/Generic/Tests/CodeAnalysis/AssignmentInConditionUnitTest.inc

@@ -25,7 +25,7 @@ do {
 
 while ( $sample === false ) {}
 
- // Silly, but not an assignment.
+// Silly, but not an assignment.
 if (123 = $a) {}
 if (strtolower($b) = $b) {}
 if (array( 1 => 'a', 2 => 'b' ) = $b) {}

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

@@ -38,9 +38,9 @@ class FunctionSpacingSniff implements Sniff
     public $spacingAfterLast = 2;
 
     /**
-     * The number of blank lines after the last function in a class.
+     * Original properties as set in a custom ruleset (if any).
      *
-     * @var integer
+     * @var array
      */
     private $rulesetProperties = null;
 

src/Tokenizers/PHP.php

@@ -781,7 +781,7 @@ protected function tokenize($string)
                 && $tokens[($stackPtr + 2)][0] === T_STRING
                 && strtolower($tokens[($stackPtr + 2)][1]) === 'from'
             ) {
-                // Could be multi-line, so just just the token stack.
+                // Could be multi-line, so just the token stack.
                 $token[0] = T_YIELD_FROM;
                 $token[1] = $token[1].$tokens[($stackPtr + 1)][1].$tokens[($stackPtr + 2)][1];
 

src/Tokenizers/Tokenizer.php

@@ -87,7 +87,7 @@ public function __construct($content, $config, $eolChar='\n')
     /**
      * Checks the content to see if it looks minified.
      *
-     * @param string $content The content to tokenize,
+     * @param string $content The content to tokenize.
      * @param string $eolChar The EOL char used in the content.
      *
      * @return boolean
@@ -1372,7 +1372,7 @@ private function recurseScopeMap($stackPtr, $depth=1, &$ignore=0)
      *
      * The level map adds a 'level' index to each token which indicates the
      * depth that a token within a set of scope blocks. It also adds a
-     * 'condition' index which is an array of the scope conditions that opened
+     * 'conditions' index which is an array of the scope conditions that opened
      * each of the scopes - position 0 being the first scope opener.
      *
      * @return void

src/Util/Tokens.php

@@ -145,9 +145,9 @@ final class Tokens
         T_FUNCTION            => 100,
         T_CLOSURE             => 100,
 
-                                 /*
-                                     Conditions.
-                                 */
+        /*
+         * Conditions.
+         */
 
         T_WHILE               => 50,
         T_FOR                 => 50,
@@ -164,9 +164,9 @@ final class Tokens
         T_SELF                => 25,
         T_PARENT              => 25,
 
-                                 /*
-                                     Operators and arithmetic.
-                                 */
+        /*
+         * Operators and arithmetic.
+         */
 
         T_BITWISE_AND         => 8,
         T_BITWISE_OR          => 8,
@@ -201,9 +201,9 @@ final class Tokens
         T_BOOLEAN_AND         => 5,
         T_BOOLEAN_OR          => 5,
 
-                                 /*
-                                     Equality.
-                                 */
+        /*
+         * Equality.
+         */
 
         T_IS_EQUAL            => 5,
         T_IS_NOT_EQUAL        => 5,
@@ -566,7 +566,7 @@ final class Tokens
     ];
 
     /**
-     * Tokens that are open class and object scopes.
+     * Tokens that open class and object scopes.
      *
      * @var array<int, int>
      */

tests/Core/File/FindEndOfStatementTest.php

@@ -145,7 +145,7 @@ public function testHeredocFunctionArg()
      */
     public function testSwitch()
     {
-        // Find the end of the swtich.
+        // Find the end of the switch.
         $start = ($this->phpcsFile->findNext(T_COMMENT, 0, null, false, '/* testSwitch */') + 2);
         $found = $this->phpcsFile->findEndOfStatement($start);