Merge pull request #155 from PHPCSStandards/docs/update-since-tags

jrfnl · web-flow · commit 36f1be626398 · 2020-06-14T14:04:27.000+02:00
Docs: update since tags
diff --git a/PHPCSUtils/BackCompat/BCFile.php b/PHPCSUtils/BackCompat/BCFile.php
@@ -538,6 +538,7 @@ public static function getMethodParameters(File $phpcsFile, $stackPtr)
      *
      * @since 1.0.0
      * @since 1.0.0-alpha2 Added BC support for PHP 7.4 arrow functions.
+     * @since 1.0.0-alpha3 Added support for PHP 8.0 static return type (expected in future PHPCS release).
      *
      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
      * @param int                         $stackPtr  The position in the stack of the function token to
diff --git a/PHPCSUtils/BackCompat/BCTokens.php b/PHPCSUtils/BackCompat/BCTokens.php
@@ -64,6 +64,7 @@ class BCTokens
      * Token types that are comments containing PHPCS instructions.
      *
      * @since 1.0.0
+     * @since 1.0.0-alpha3 Visibility changed from `protected` to `private`.
      *
      * @var string[]
      */
@@ -79,6 +80,7 @@ class BCTokens
      * Tokens that open class and object scopes.
      *
      * @since 1.0.0
+     * @since 1.0.0-alpha3 Visibility changed from `protected` to `private`.
      *
      * @var array <int|string> => <int|string>
      */
@@ -93,6 +95,7 @@ class BCTokens
      * Tokens that represent text strings.
      *
      * @since 1.0.0
+     * @since 1.0.0-alpha3 Visibility changed from `protected` to `private`.
      *
      * @var array <int|string> => <int|string>
      */
diff --git a/PHPCSUtils/BackCompat/Helper.php b/PHPCSUtils/BackCompat/Helper.php
@@ -173,7 +173,7 @@ public static function getTabWidth(File $phpcsFile)
      * Get the applicable (file) encoding as passed to PHP_CodeSniffer from the
      * command-line or the ruleset.
      *
-     * @since 1.0.0
+     * @since 1.0.0-alpha3
      *
      * @param \PHP_CodeSniffer\Files\File|null $phpcsFile Optional. The current file being processed.
      *
diff --git a/PHPCSUtils/TestUtils/UtilityMethodTestCase.php b/PHPCSUtils/TestUtils/UtilityMethodTestCase.php
@@ -103,7 +103,7 @@ abstract class UtilityMethodTestCase extends TestCase
     /**
      * The PHPCS version the tests are being run on.
      *
-     * @since 1.0.0
+     * @since 1.0.0-alpha3
      *
      * @var string
      */
@@ -275,7 +275,7 @@ public static function setUpTestFile()
      * Note: This is a PHPUnit cross-version compatible {@see \PHPUnit\Framework\TestCase::setUp()}
      * method.
      *
-     * @since 1.0.0
+     * @since 1.0.0-alpha3
      *
      * @before
      *
diff --git a/PHPCSUtils/Tokens/Collections.php b/PHPCSUtils/Tokens/Collections.php
@@ -204,7 +204,7 @@ class Collections
      *
      * @link https://www.php.net/language.constants.predefined PHP Manual on magic constants
      *
-     * @since 1.0.0
+     * @since 1.0.0-alpha3
      *
      * @var array <int|string> => <int|string>
      */
@@ -289,7 +289,7 @@ class Collections
      *
      * @link https://www.php.net/language.oop5.paamayim-nekudotayim PHP Manual on OO forwarding calls
      *
-     * @since 1.0.0
+     * @since 1.0.0-alpha3
      *
      * @var array <int|string> => <int|string>
      */
@@ -307,7 +307,7 @@ class Collections
      * echo namespace\Sub\ClassName::method();
      * ```
      *
-     * @since 1.0.0
+     * @since 1.0.0-alpha3
      *
      * @var array <int|string> => <int|string>
      */
@@ -520,7 +520,7 @@ class Collections
      *
      * Note: this is a method, not a property as the `T_FN` token for arrow functions may not exist.
      *
-     * @since 1.0.0
+     * @since 1.0.0-alpha2
      *
      * @return array <int|string> => <int|string>
      */
@@ -549,7 +549,7 @@ public static function arrowFunctionTokensBC()
      *
      * @see \PHPCSUtils\Tokens\Collections::functionDeclarationTokensBC() Related method (PHPCS 2.6.0+).
      *
-     * @since 1.0.0
+     * @since 1.0.0-alpha3
      *
      * @return array <int|string> => <int|string>
      */
@@ -590,7 +590,7 @@ public static function functionDeclarationTokens()
      * @see \PHPCSUtils\Tokens\Collections::functionDeclarationTokens() Related method (PHPCS 3.5.3+).
      * @see \PHPCSUtils\Utils\FunctionDeclarations::isArrowFunction()   Arrow function verification.
      *
-     * @since 1.0.0
+     * @since 1.0.0-alpha3
      *
      * @return array <int|string> => <int|string>
      */
@@ -622,7 +622,7 @@ public static function functionDeclarationTokensBC()
      *
      * @see \PHPCSUtils\Tokens\Collections::$parameterTypeTokens Related property (PHPCS 3.3.0+).
      *
-     * @since 1.0.0
+     * @since 1.0.0-alpha3
      *
      * @return array <int|string> => <int|string>
      */
@@ -654,7 +654,7 @@ public static function parameterTypeTokensBC()
      *
      * @see \PHPCSUtils\Tokens\Collections::$propertyTypeTokens Related property (PHPCS 3.3.0+).
      *
-     * @since 1.0.0
+     * @since 1.0.0-alpha3
      *
      * @return array <int|string> => <int|string>
      */
@@ -680,7 +680,7 @@ public static function propertyTypeTokensBC()
      *
      * @see \PHPCSUtils\Tokens\Collections::$returnTypeTokens Related property (PHPCS 3.5.4+).
      *
-     * @since 1.0.0
+     * @since 1.0.0-alpha3
      *
      * @return array <int|string> => <int|string>
      */
diff --git a/PHPCSUtils/Utils/ControlStructures.php b/PHPCSUtils/Utils/ControlStructures.php
@@ -348,7 +348,7 @@ public static function getDeclareScopeOpenClose(File $phpcsFile, $stackPtr)
     /**
      * Retrieve the exception(s) being caught in a CATCH condition.
      *
-     * @since 1.0.0
+     * @since 1.0.0-alpha3
      *
      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
      * @param int                         $stackPtr  The position of the token we are checking.
diff --git a/PHPCSUtils/Utils/FunctionDeclarations.php b/PHPCSUtils/Utils/FunctionDeclarations.php
@@ -176,6 +176,7 @@ public static function getName(File $phpcsFile, $stackPtr)
      *
      * @since 1.0.0
      * @since 1.0.0-alpha2 Added BC support for PHP 7.4 arrow functions.
+     * @since 1.0.0-alpha3 Added support for PHP 8.0 static return type.
      *
      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
      * @param int                         $stackPtr  The position in the stack of the function token to
diff --git a/PHPCSUtils/Utils/Lists.php b/PHPCSUtils/Utils/Lists.php
@@ -292,6 +292,8 @@ public static function getOpenClose(File $phpcsFile, $stackPtr, $isShortList = n
      * ```
      *
      * @since 1.0.0
+     * @since 1.0.0-alpha3 The returned value has been simplified with sensible defaults and always
+     *                     available keys.
      *
      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
      * @param int                         $stackPtr  The position in the stack of the function token
diff --git a/PHPCSUtils/Utils/NamingConventions.php b/PHPCSUtils/Utils/NamingConventions.php
@@ -22,7 +22,7 @@
  * - {@link https://www.php.net/language.variables.basics variable} names;
  * - {@link https://www.php.net/language.constants constant} names.
  *
- * @since 1.0.0
+ * @since 1.0.0-alpha3
  */
 class NamingConventions
 {
diff --git a/PHPCSUtils/Utils/UseStatements.php b/PHPCSUtils/Utils/UseStatements.php
@@ -368,7 +368,7 @@ public static function splitImportUseStatement(File $phpcsFile, $stackPtr)
      * @see \PHPCSUtils\AbstractSniffs\AbstractFileContextSniff
      * @see \PHPCSUtils\Utils\UseStatements::splitImportUseStatement()
      *
-     * @since 1.0.0
+     * @since 1.0.0-alpha3
      *
      * @param \PHP_CodeSniffer\Files\File $phpcsFile             The file where this token was found.
      * @param int                         $stackPtr              The position in the stack of the `T_USE` token.

Original file line number	Diff line number	Diff line change
`@@ -538,6 +538,7 @@ public static function getMethodParameters(File $phpcsFile, $stackPtr)`
`538`	`538`	`*`
`539`	`539`	`* @since 1.0.0`
`540`	`540`	`* @since 1.0.0-alpha2 Added BC support for PHP 7.4 arrow functions.`
	`541`	`+ * @since 1.0.0-alpha3 Added support for PHP 8.0 static return type (expected in future PHPCS release).`
`541`	`542`	`*`
`542`	`543`	`* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.`
`543`	`544`	`* @param int $stackPtr The position in the stack of the function token to`
Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,7 @@ class BCTokens`
`64`	`64`	`* Token types that are comments containing PHPCS instructions.`
`65`	`65`	`*`
`66`	`66`	`* @since 1.0.0`
	`67`	+ * @since 1.0.0-alpha3 Visibility changed from `protected` to `private`.
`67`	`68`	`*`
`68`	`69`	`* @var string[]`
`69`	`70`	`*/`
`@@ -79,6 +80,7 @@ class BCTokens`
`79`	`80`	`* Tokens that open class and object scopes.`
`80`	`81`	`*`
`81`	`82`	`* @since 1.0.0`
	`83`	+ * @since 1.0.0-alpha3 Visibility changed from `protected` to `private`.
`82`	`84`	`*`
`83`	`85`	`* @var array <int\|string> => <int\|string>`
`84`	`86`	`*/`
`@@ -93,6 +95,7 @@ class BCTokens`
`93`	`95`	`* Tokens that represent text strings.`
`94`	`96`	`*`
`95`	`97`	`* @since 1.0.0`
	`98`	+ * @since 1.0.0-alpha3 Visibility changed from `protected` to `private`.
`96`	`99`	`*`
`97`	`100`	`* @var array <int\|string> => <int\|string>`
`98`	`101`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,7 @@ public static function getTabWidth(File $phpcsFile)`
`173`	`173`	`* Get the applicable (file) encoding as passed to PHP_CodeSniffer from the`
`174`	`174`	`* command-line or the ruleset.`
`175`	`175`	`*`
`176`		`- * @since 1.0.0`
	`176`	`+ * @since 1.0.0-alpha3`
`177`	`177`	`*`
`178`	`178`	`* @param \PHP_CodeSniffer\Files\File\|null $phpcsFile Optional. The current file being processed.`
`179`	`179`	`*`
Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ abstract class UtilityMethodTestCase extends TestCase`
`103`	`103`	`/**`
`104`	`104`	`* The PHPCS version the tests are being run on.`
`105`	`105`	`*`
`106`		`- * @since 1.0.0`
	`106`	`+ * @since 1.0.0-alpha3`
`107`	`107`	`*`
`108`	`108`	`* @var string`
`109`	`109`	`*/`
`@@ -275,7 +275,7 @@ public static function setUpTestFile()`
`275`	`275`	`* Note: This is a PHPUnit cross-version compatible {@see \PHPUnit\Framework\TestCase::setUp()}`
`276`	`276`	`* method.`
`277`	`277`	`*`
`278`		`- * @since 1.0.0`
	`278`	`+ * @since 1.0.0-alpha3`
`279`	`279`	`*`
`280`	`280`	`* @before`
`281`	`281`	`*`
Original file line number	Diff line number	Diff line change
`@@ -204,7 +204,7 @@ class Collections`
`204`	`204`	`*`
`205`	`205`	`* @link https://www.php.net/language.constants.predefined PHP Manual on magic constants`
`206`	`206`	`*`
`207`		`- * @since 1.0.0`
	`207`	`+ * @since 1.0.0-alpha3`
`208`	`208`	`*`
`209`	`209`	`* @var array <int\|string> => <int\|string>`
`210`	`210`	`*/`
`@@ -289,7 +289,7 @@ class Collections`
`289`	`289`	`*`
`290`	`290`	`* @link https://www.php.net/language.oop5.paamayim-nekudotayim PHP Manual on OO forwarding calls`
`291`	`291`	`*`
`292`		`- * @since 1.0.0`
	`292`	`+ * @since 1.0.0-alpha3`
`293`	`293`	`*`
`294`	`294`	`* @var array <int\|string> => <int\|string>`
`295`	`295`	`*/`
`@@ -307,7 +307,7 @@ class Collections`
`307`	`307`	`* echo namespace\Sub\ClassName::method();`
`308`	`308`	* ```
`309`	`309`	`*`
`310`		`- * @since 1.0.0`
	`310`	`+ * @since 1.0.0-alpha3`
`311`	`311`	`*`
`312`	`312`	`* @var array <int\|string> => <int\|string>`
`313`	`313`	`*/`
`@@ -520,7 +520,7 @@ class Collections`
`520`	`520`	`*`
`521`	`521`	* Note: this is a method, not a property as the `T_FN` token for arrow functions may not exist.
`522`	`522`	`*`
`523`		`- * @since 1.0.0`
	`523`	`+ * @since 1.0.0-alpha2`
`524`	`524`	`*`
`525`	`525`	`* @return array <int\|string> => <int\|string>`
`526`	`526`	`*/`
`@@ -549,7 +549,7 @@ public static function arrowFunctionTokensBC()`
`549`	`549`	`*`
`550`	`550`	`* @see \PHPCSUtils\Tokens\Collections::functionDeclarationTokensBC() Related method (PHPCS 2.6.0+).`
`551`	`551`	`*`
`552`		`- * @since 1.0.0`
	`552`	`+ * @since 1.0.0-alpha3`
`553`	`553`	`*`
`554`	`554`	`* @return array <int\|string> => <int\|string>`
`555`	`555`	`*/`
`@@ -590,7 +590,7 @@ public static function functionDeclarationTokens()`
`590`	`590`	`* @see \PHPCSUtils\Tokens\Collections::functionDeclarationTokens() Related method (PHPCS 3.5.3+).`
`591`	`591`	`* @see \PHPCSUtils\Utils\FunctionDeclarations::isArrowFunction() Arrow function verification.`
`592`	`592`	`*`
`593`		`- * @since 1.0.0`
	`593`	`+ * @since 1.0.0-alpha3`
`594`	`594`	`*`
`595`	`595`	`* @return array <int\|string> => <int\|string>`
`596`	`596`	`*/`
`@@ -622,7 +622,7 @@ public static function functionDeclarationTokensBC()`
`622`	`622`	`*`
`623`	`623`	`* @see \PHPCSUtils\Tokens\Collections::$parameterTypeTokens Related property (PHPCS 3.3.0+).`
`624`	`624`	`*`
`625`		`- * @since 1.0.0`
	`625`	`+ * @since 1.0.0-alpha3`
`626`	`626`	`*`
`627`	`627`	`* @return array <int\|string> => <int\|string>`
`628`	`628`	`*/`
`@@ -654,7 +654,7 @@ public static function parameterTypeTokensBC()`
`654`	`654`	`*`
`655`	`655`	`* @see \PHPCSUtils\Tokens\Collections::$propertyTypeTokens Related property (PHPCS 3.3.0+).`
`656`	`656`	`*`
`657`		`- * @since 1.0.0`
	`657`	`+ * @since 1.0.0-alpha3`
`658`	`658`	`*`
`659`	`659`	`* @return array <int\|string> => <int\|string>`
`660`	`660`	`*/`
`@@ -680,7 +680,7 @@ public static function propertyTypeTokensBC()`
`680`	`680`	`*`
`681`	`681`	`* @see \PHPCSUtils\Tokens\Collections::$returnTypeTokens Related property (PHPCS 3.5.4+).`
`682`	`682`	`*`
`683`		`- * @since 1.0.0`
	`683`	`+ * @since 1.0.0-alpha3`
`684`	`684`	`*`
`685`	`685`	`* @return array <int\|string> => <int\|string>`
`686`	`686`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -348,7 +348,7 @@ public static function getDeclareScopeOpenClose(File $phpcsFile, $stackPtr)`
`348`	`348`	`/**`
`349`	`349`	`* Retrieve the exception(s) being caught in a CATCH condition.`
`350`	`350`	`*`
`351`		`- * @since 1.0.0`
	`351`	`+ * @since 1.0.0-alpha3`
`352`	`352`	`*`
`353`	`353`	`* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.`
`354`	`354`	`* @param int $stackPtr The position of the token we are checking.`
Original file line number	Diff line number	Diff line change
`@@ -176,6 +176,7 @@ public static function getName(File $phpcsFile, $stackPtr)`
`176`	`176`	`*`
`177`	`177`	`* @since 1.0.0`
`178`	`178`	`* @since 1.0.0-alpha2 Added BC support for PHP 7.4 arrow functions.`
	`179`	`+ * @since 1.0.0-alpha3 Added support for PHP 8.0 static return type.`
`179`	`180`	`*`
`180`	`181`	`* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.`
`181`	`182`	`* @param int $stackPtr The position in the stack of the function token to`
Original file line number	Diff line number	Diff line change
`@@ -292,6 +292,8 @@ public static function getOpenClose(File $phpcsFile, $stackPtr, $isShortList = n`
`292`	`292`	* ```
`293`	`293`	`*`
`294`	`294`	`* @since 1.0.0`
	`295`	`+ * @since 1.0.0-alpha3 The returned value has been simplified with sensible defaults and always`
	`296`	`+ * available keys.`
`295`	`297`	`*`
`296`	`298`	`* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.`
`297`	`299`	`* @param int $stackPtr The position in the stack of the function token`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`* - {@link https://www.php.net/language.variables.basics variable} names;`
`23`	`23`	`* - {@link https://www.php.net/language.constants constant} names.`
`24`	`24`	`*`
`25`		`- * @since 1.0.0`
	`25`	`+ * @since 1.0.0-alpha3`
`26`	`26`	`*/`
`27`	`27`	`class NamingConventions`
`28`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -368,7 +368,7 @@ public static function splitImportUseStatement(File $phpcsFile, $stackPtr)`
`368`	`368`	`* @see \PHPCSUtils\AbstractSniffs\AbstractFileContextSniff`
`369`	`369`	`* @see \PHPCSUtils\Utils\UseStatements::splitImportUseStatement()`
`370`	`370`	`*`
`371`		`- * @since 1.0.0`
	`371`	`+ * @since 1.0.0-alpha3`
`372`	`372`	`*`
`373`	`373`	`* @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.`
`374`	`374`	* @param int $stackPtr The position in the stack of the `T_USE` token.