Docs: improve type declarations

This commit addresses the `@return` tag for all sniff `register()` methods. Future commits may follow for other parts of the codebase.

PHP native tokens will always be integers.
PHP_CodeSniffer polyfilled and PHP_CodeSniffer native tokens will always be strings.

While some sniffs only return one or the other, I've chosen to update these tags to be the same across all sniffs for consistency.

Author: jrfnl

src/Sniffs/AbstractArraySniff.php

@@ -19,7 +19,7 @@ abstract class AbstractArraySniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     final public function register()
     {

src/Sniffs/AbstractPatternSniff.php

@@ -78,7 +78,7 @@ public function __construct($ignoreComments=null)
      * Classes extending <i>AbstractPatternTest</i> should implement the
      * <i>getPatterns()</i> method to register the patterns they wish to test.
      *
-     * @return int[]
+     * @return array<int|string>
      * @see    process()
      */
     final public function register()

src/Sniffs/AbstractScopeSniff.php

@@ -104,7 +104,7 @@ public function __construct(
      * DO NOT OVERRIDE THIS METHOD. Use the constructor of this class to register
      * for the desired tokens and scope.
      *
-     * @return int[]
+     * @return array<int|string>
      * @see    __constructor()
      */
     final public function register()

src/Sniffs/Sniff.php

@@ -28,13 +28,13 @@ interface Sniff
      *
      * <code>
      *    return array(
-     *            T_WHITESPACE,
-     *            T_DOC_COMMENT,
-     *            T_COMMENT,
-     *           );
+     *        T_WHITESPACE,
+     *        T_DOC_COMMENT,
+     *        T_COMMENT,
+     *    );
      * </code>
      *
-     * @return mixed[]
+     * @return array<int|string>
      * @see    Tokens.php
      */
     public function register();

src/Standards/Generic/Sniffs/Arrays/DisallowLongArraySyntaxSniff.php

@@ -19,7 +19,7 @@ class DisallowLongArraySyntaxSniff implements Sniff
     /**
      * Registers the tokens that this sniff wants to listen for.
      *
-     * @return int[]
+     * @return array<int|string>
      */
     public function register()
     {

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

@@ -26,7 +26,7 @@ class DuplicateClassNameSniff implements Sniff
     /**
      * Registers the tokens that this sniff wants to listen for.
      *
-     * @return int[]
+     * @return array<int|string>
      */
     public function register()
     {

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

@@ -19,7 +19,7 @@ class OpeningBraceSameLineSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/CodeAnalysis/AssignmentInConditionSniff.php

@@ -40,7 +40,7 @@ class AssignmentInConditionSniff implements Sniff
     /**
      * Registers the tokens that this sniff wants to listen for.
      *
-     * @return int[]
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/CodeAnalysis/EmptyPHPStatementSniff.php

@@ -23,7 +23,7 @@ class EmptyPHPStatementSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return int[]
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/CodeAnalysis/EmptyStatementSniff.php

@@ -34,7 +34,7 @@ class EmptyStatementSniff implements Sniff
     /**
      * Registers the tokens that this sniff wants to listen for.
      *
-     * @return int[]
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/CodeAnalysis/ForLoopShouldBeWhileLoopSniff.php

@@ -33,7 +33,7 @@ class ForLoopShouldBeWhileLoopSniff implements Sniff
     /**
      * Registers the tokens that this sniff wants to listen for.
      *
-     * @return int[]
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/CodeAnalysis/ForLoopWithTestFunctionCallSniff.php

@@ -37,7 +37,7 @@ class ForLoopWithTestFunctionCallSniff implements Sniff
     /**
      * Registers the tokens that this sniff wants to listen for.
      *
-     * @return int[]
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/CodeAnalysis/JumbledIncrementerSniff.php

@@ -39,7 +39,7 @@ class JumbledIncrementerSniff implements Sniff
     /**
      * Registers the tokens that this sniff wants to listen for.
      *
-     * @return int[]
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/CodeAnalysis/UnconditionalIfStatementSniff.php

@@ -37,7 +37,7 @@ class UnconditionalIfStatementSniff implements Sniff
     /**
      * Registers the tokens that this sniff wants to listen for.
      *
-     * @return int[]
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/CodeAnalysis/UnnecessaryFinalModifierSniff.php

@@ -32,7 +32,7 @@ class UnnecessaryFinalModifierSniff implements Sniff
     /**
      * Registers the tokens that this sniff wants to listen for.
      *
-     * @return int[]
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/CodeAnalysis/UnusedFunctionParameterSniff.php

@@ -60,7 +60,7 @@ class UnusedFunctionParameterSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/CodeAnalysis/UselessOverridingMethodSniff.php

@@ -32,7 +32,7 @@ class UselessOverridingMethodSniff implements Sniff
     /**
      * Registers the tokens that this sniff wants to listen for.
      *
-     * @return int[]
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Commenting/DocCommentSniff.php

@@ -30,7 +30,7 @@ class DocCommentSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Commenting/FixmeSniff.php

@@ -31,7 +31,7 @@ class FixmeSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Commenting/TodoSniff.php

@@ -30,7 +30,7 @@ class TodoSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/ControlStructures/DisallowYodaConditionsSniff.php

@@ -21,7 +21,7 @@ class DisallowYodaConditionsSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/ControlStructures/InlineControlStructureSniff.php

@@ -37,7 +37,7 @@ class InlineControlStructureSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Debug/CSSLintSniff.php

@@ -28,7 +28,7 @@ class CSSLintSniff implements Sniff
     /**
      * Returns the token types that this sniff is interested in.
      *
-     * @return int[]
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Debug/ClosureLinterSniff.php

@@ -44,7 +44,7 @@ class ClosureLinterSniff implements Sniff
     /**
      * Returns the token types that this sniff is interested in.
      *
-     * @return int[]
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Debug/ESLintSniff.php

@@ -35,7 +35,7 @@ class ESLintSniff implements Sniff
     /**
      * Returns the token types that this sniff is interested in.
      *
-     * @return int[]
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Debug/JSHintSniff.php

@@ -29,7 +29,7 @@ class JSHintSniff implements Sniff
     /**
      * Returns the token types that this sniff is interested in.
      *
-     * @return int[]
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Files/ByteOrderMarkSniff.php

@@ -33,7 +33,7 @@ class ByteOrderMarkSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Files/EndFileNewlineSniff.php

@@ -30,7 +30,7 @@ class EndFileNewlineSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Files/EndFileNoNewlineSniff.php

@@ -30,7 +30,7 @@ class EndFileNoNewlineSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Files/ExecutableFileSniff.php

@@ -19,7 +19,7 @@ class ExecutableFileSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Files/InlineHTMLSniff.php

@@ -32,7 +32,7 @@ class InlineHTMLSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Files/LineEndingsSniff.php

@@ -37,7 +37,7 @@ class LineEndingsSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Files/LineLengthSniff.php

@@ -50,7 +50,7 @@ class LineLengthSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Files/LowercasedFilenameSniff.php

@@ -19,7 +19,7 @@ class LowercasedFilenameSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Files/OneClassPerFileSniff.php

@@ -19,7 +19,7 @@ class OneClassPerFileSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Files/OneInterfacePerFileSniff.php

@@ -19,7 +19,7 @@ class OneInterfacePerFileSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Files/OneObjectStructurePerFileSniff.php

@@ -19,7 +19,7 @@ class OneObjectStructurePerFileSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Files/OneTraitPerFileSniff.php

@@ -19,7 +19,7 @@ class OneTraitPerFileSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Formatting/DisallowMultipleStatementsSniff.php

@@ -19,7 +19,7 @@ class DisallowMultipleStatementsSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Formatting/MultipleStatementAlignmentSniff.php

@@ -58,7 +58,7 @@ class MultipleStatementAlignmentSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Formatting/NoSpaceAfterCastSniff.php

@@ -23,7 +23,7 @@ class NoSpaceAfterCastSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Formatting/SpaceAfterCastSniff.php

@@ -34,7 +34,7 @@ class SpaceAfterCastSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {

src/Standards/Generic/Sniffs/Formatting/SpaceAfterNotSniff.php

@@ -44,7 +44,7 @@ class SpaceAfterNotSniff implements Sniff
     /**
      * Returns an array of tokens this test wants to listen for.
      *
-     * @return array
+     * @return array<int|string>
      */
     public function register()
     {