Merge pull request #901 from PHPCSStandards/feature/various-minor-docs-fixes

Docs: various minor fixes

Author: jrfnl

autoload.php

@@ -26,7 +26,8 @@ class Autoload
         /**
          * The composer autoloader.
          *
-         * @var \Composer\Autoload\ClassLoader
+         * @var \Composer\Autoload\ClassLoader|false|null The autoloader object or FALSE if no Composer autoloader could
+         *                                                be found. NULL when this hasn't been determined yet.
          */
         private static $composerAutoloader = null;
 

src/Files/File.php

@@ -656,13 +656,13 @@ public function cleanUp()
     /**
      * Records an error against a specific token in the file.
      *
-     * @param string  $error    The error message.
-     * @param int     $stackPtr The stack position where the error occurred.
-     * @param string  $code     A violation code unique to the sniff message.
-     * @param array   $data     Replacements for the error message.
-     * @param int     $severity The severity level for this error. A value of 0
-     *                          will be converted into the default severity level.
-     * @param boolean $fixable  Can the error be fixed by the sniff?
+     * @param string   $error    The error message.
+     * @param int|null $stackPtr The stack position where the error occurred.
+     * @param string   $code     A violation code unique to the sniff message.
+     * @param array    $data     Replacements for the error message.
+     * @param int      $severity The severity level for this error. A value of 0
+     *                           will be converted into the default severity level.
+     * @param boolean  $fixable  Can the error be fixed by the sniff?
      *
      * @return boolean
      */
@@ -690,13 +690,13 @@ public function addError(
     /**
      * Records a warning against a specific token in the file.
      *
-     * @param string  $warning  The error message.
-     * @param int     $stackPtr The stack position where the error occurred.
-     * @param string  $code     A violation code unique to the sniff message.
-     * @param array   $data     Replacements for the warning message.
-     * @param int     $severity The severity level for this warning. A value of 0
-     *                          will be converted into the default severity level.
-     * @param boolean $fixable  Can the warning be fixed by the sniff?
+     * @param string   $warning  The error message.
+     * @param int|null $stackPtr The stack position where the error occurred.
+     * @param string   $code     A violation code unique to the sniff message.
+     * @param array    $data     Replacements for the warning message.
+     * @param int      $severity The severity level for this warning. A value of 0
+     *                           will be converted into the default severity level.
+     * @param boolean  $fixable  Can the warning be fixed by the sniff?
      *
      * @return boolean
      */

src/Standards/Generic/Sniffs/Classes/DuplicateClassNameSniff.php

@@ -43,7 +43,7 @@ public function register()
      * @param int                         $stackPtr  The position of the current token
      *                                               in the stack passed in $tokens.
      *
-     * @return void
+     * @return int
      */
     public function process(File $phpcsFile, $stackPtr)
     {

src/Standards/Generic/Sniffs/WhiteSpace/LanguageConstructSpacingSniff.php

@@ -51,7 +51,8 @@ public function register()
      * @param int                         $stackPtr  The position of the current token in
      *                                               the stack passed in $tokens.
      *
-     * @return void
+     * @return int|void Integer stack pointer to skip forward or void to continue
+     *                  normal file processing.
      */
     public function process(File $phpcsFile, $stackPtr)
     {

src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.php

@@ -43,7 +43,7 @@ public function setCliValues($testFile, $config)
      *
      * @param string $testFile The name of the file being tested.
      *
-     * @return array(int => int)
+     * @return array<int, int>
      */
     public function getErrorList($testFile='')
     {
@@ -115,7 +115,7 @@ public function getErrorList($testFile='')
      * The key of the array should represent the line number and the value
      * should represent the number of warnings that should occur on that line.
      *
-     * @return array(int => int)
+     * @return array<int, int>
      */
     public function getWarningList()
     {

src/Standards/Generic/Tests/Files/OneTraitPerFileUnitTest.php

@@ -26,7 +26,7 @@ final class OneTraitPerFileUnitTest extends AbstractSniffUnitTest
      * The key of the array should represent the line number and the value
      * should represent the number of errors that should occur on that line.
      *
-     * @return array(int => int)
+     * @return array<int, int>
      */
     public function getErrorList()
     {
@@ -44,7 +44,7 @@ public function getErrorList()
      * The key of the array should represent the line number and the value
      * should represent the number of warnings that should occur on that line.
      *
-     * @return array(int => int)
+     * @return array<int, int>
      */
     public function getWarningList()
     {

src/Standards/Squiz/Sniffs/Classes/ClassFileNameSniff.php

@@ -39,7 +39,8 @@ public function register()
      * @param int                         $stackPtr  The position of the current token in
      *                                               the stack passed in $tokens.
      *
-     * @return void
+     * @return int|void Integer stack pointer to skip forward or void to continue
+     *                  normal file processing.
      */
     public function process(File $phpcsFile, $stackPtr)
     {

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

@@ -28,7 +28,7 @@ class LongConditionClosingCommentSniff implements Sniff
     /**
      * The openers that we are interested in.
      *
-     * @var integer[]
+     * @var array<int|string>
      */
     private static $openers = [
         T_SWITCH,

src/Standards/Squiz/Sniffs/Operators/ComparisonOperatorUsageSniff.php

@@ -44,7 +44,7 @@ class ComparisonOperatorUsageSniff implements Sniff
     /**
      * A list of invalid operators with their alternatives.
      *
-     * @var array<string, array<int, string>>
+     * @var array<string, array<int|string, string>>
      */
     private static $invalidOps = [
         'PHP' => [

tests/Core/AbstractMethodUnitTest.php

@@ -164,9 +164,9 @@ public static function assertTestMarkersAreUnique(File $phpcsFile)
      * Note: the test delimiter comment MUST start with "/* test" to allow this function to
      * distinguish between comments used *in* a test and test delimiters.
      *
-     * @param string           $commentString The delimiter comment to look for.
-     * @param int|string|array $tokenType     The type of token(s) to look for.
-     * @param string           $tokenContent  Optional. The token content for the target token.
+     * @param string                       $commentString The delimiter comment to look for.
+     * @param int|string|array<int|string> $tokenType     The type of token(s) to look for.
+     * @param string                       $tokenContent  Optional. The token content for the target token.
      *
      * @return int
      */
@@ -183,10 +183,10 @@ public function getTargetToken($commentString, $tokenType, $tokenContent=null)
      * Note: the test delimiter comment MUST start with "/* test" to allow this function to
      * distinguish between comments used *in* a test and test delimiters.
      *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile     The file to find the token in.
-     * @param string                      $commentString The delimiter comment to look for.
-     * @param int|string|array            $tokenType     The type of token(s) to look for.
-     * @param string                      $tokenContent  Optional. The token content for the target token.
+     * @param \PHP_CodeSniffer\Files\File  $phpcsFile     The file to find the token in.
+     * @param string                       $commentString The delimiter comment to look for.
+     * @param int|string|array<int|string> $tokenType     The type of token(s) to look for.
+     * @param string                       $tokenContent  Optional. The token content for the target token.
      *
      * @return int
      *