Merge pull request #673 from PHPCSStandards/feature/various-minor-doc-fixes

Docs: various minor fixes

Author: jrfnl

PHPCSUtils/Internal/IsShortArrayOrList.php

@@ -352,15 +352,13 @@ private function isSquareBracket()
     /**
      * Verify that the current set of brackets is not affected by known PHPCS cross-version tokenizer issues.
      *
-     * List of current tokenizer issues which affect the short array/short list tokenization:
-     * - {@link https://github.com/squizlabs/PHP_CodeSniffer/pull/3632 PHPCS#3632} (PHPCS < 3.7.2)
-     *
      * List of previous tokenizer issues which affected the short array/short list tokenization for reference:
      * - {@link https://github.com/squizlabs/PHP_CodeSniffer/issues/1284 PHPCS#1284} (PHPCS < 2.8.1)
      * - {@link https://github.com/squizlabs/PHP_CodeSniffer/issues/1381 PHPCS#1381} (PHPCS < 2.9.0)
      * - {@link https://github.com/squizlabs/PHP_CodeSniffer/issues/1971 PHPCS#1971} (PHPCS 2.8.0 - 3.2.3)
      * - {@link https://github.com/squizlabs/PHP_CodeSniffer/pull/3013 PHPCS#3013} (PHPCS < 3.5.6)
      * - {@link https://github.com/squizlabs/PHP_CodeSniffer/pull/3172 PHPCS#3172} (PHPCS < 3.6.0)
+     * - {@link https://github.com/squizlabs/PHP_CodeSniffer/pull/3632 PHPCS#3632} (PHPCS < 3.7.2)
      *
      * @since 1.0.0
      *
@@ -370,7 +368,7 @@ private function isSquareBracket()
     private function isShortArrayBracket()
     {
         if ($this->tokens[$this->opener]['code'] === \T_OPEN_SQUARE_BRACKET) {
-            // Currently there are no known issues with the tokenization in PHPCS 3.9.0 and higher.
+            // Currently there are no known issues with the tokenization in PHPCS.
             return false;
         }
 

PHPCSUtils/Tokens/Collections.php

@@ -383,7 +383,7 @@ final class Collections
     /**
      * OO scopes in which constants can be declared.
      *
-     * Note: traits can only declare constants since PHP 8.2.
+     * - PHP 8.2 added support for constants in traits.
      *
      * @since 1.0.0 Use the {@see Collections::ooConstantScopes()} method for access.
      *

PHPCSUtils/Utils/Namespaces.php

@@ -116,7 +116,7 @@ public static function getType(File $phpcsFile, $stackPtr)
         }
 
         if (($tokens[$next]['code'] === \T_NS_SEPARATOR
-            || $tokens[$next]['code'] === \T_NAME_FULLY_QUALIFIED) // PHP 8.0 parse error.
+            || $tokens[$next]['code'] === \T_NAME_FULLY_QUALIFIED) // PHP >= 8.0 parse error.
             && ($start !== $stackPtr
                 || $phpcsFile->findNext($findAfter, ($stackPtr + 1), null, false, null, true) !== false)
         ) {

Tests/Utils/FileInfo/HasSheBangPHPAndUTF8BomTest.php

@@ -14,8 +14,9 @@
 use PHPCSUtils\Utils\FileInfo;
 
 /**
- * Tests for the \PHPCSUtils\Utils\FileInfo::hasSheBang() method.
+ * Tests for the \PHPCSUtils\Utils\FileInfo::hasSheBang() and \PHPCSUtils\Utils\FileInfo::hasByteOrderMark() methods.
  *
+ * @covers \PHPCSUtils\Utils\FileInfo::hasByteOrderMark
  * @covers \PHPCSUtils\Utils\FileInfo::hasSheBang
  *
  * @since 1.1.0

Tests/Utils/ObjectDeclarations/GetNameDiffTest.php

@@ -93,7 +93,7 @@ public static function dataGetNameNull()
      *
      * @param string          $testMarker The comment which prefaces the target token in the test file.
      * @param string          $expected   Expected function output.
-     * @param int|string|null $targetType Token type of the token to get as stackPtr.
+     * @param int|string|null $targetType Optional. Token type of the token to get as stackPtr.
      *
      * @return void
      */

phpcsutils-autoload.php

@@ -3,7 +3,6 @@
  * PHPCSUtils, utility functions and classes for PHP_CodeSniffer sniff developers.
  *
  * Autoloader for the PHPCSUtils files.
- * Also provides PHPCS cross-version class aliases.
  *
  * - If an external standard only supports PHPCS >= 3.1.0 and uses the PHPCS
  *   native unit test framework, this file does not need to be included.