Skip to content

Commit 5448ece

Browse files
committed
Docs: various tag order fixes
Includes moving inline `{@internal}` tags up as they can only be part of the long description as otherwise they are interpreted as meaning the function is _internal_.
1 parent 2353f96 commit 5448ece

File tree

2 files changed

+23
-23
lines changed

2 files changed

+23
-23
lines changed

PHPCSUtils/Tokens/Collections.php

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,11 @@ class Collections
6363
/**
6464
* Tokens which are used to create arrays.
6565
*
66-
* @since 1.0.0
67-
*
6866
* @see \PHPCSUtils\Tokens\Collections::$shortArrayTokens Related property containing only tokens used
6967
* for short arrays.
7068
*
69+
* @since 1.0.0
70+
*
7171
* @var array <int|string> => <int|string>
7272
*/
7373
public static $arrayTokens = [
@@ -82,11 +82,11 @@ class Collections
8282
* List which is backward-compatible with PHPCS < 3.3.0.
8383
* Should only be used selectively.
8484
*
85-
* @since 1.0.0
86-
*
8785
* @see \PHPCSUtils\Tokens\Collections::$shortArrayTokensBC Related property containing only tokens used
8886
* for short arrays (cross-version).
8987
*
88+
* @since 1.0.0
89+
*
9090
* @var array <int|string> => <int|string>
9191
*/
9292
public static $arrayTokensBC = [
@@ -165,11 +165,11 @@ class Collections
165165
/**
166166
* Tokens which are used to create lists.
167167
*
168-
* @since 1.0.0
169-
*
170168
* @see \PHPCSUtils\Tokens\Collections::$shortListTokens Related property containing only tokens used
171169
* for short lists.
172170
*
171+
* @since 1.0.0
172+
*
173173
* @var array <int|string> => <int|string>
174174
*/
175175
public static $listTokens = [
@@ -184,11 +184,11 @@ class Collections
184184
* List which is backward-compatible with PHPCS < 3.3.0.
185185
* Should only be used selectively.
186186
*
187-
* @since 1.0.0
188-
*
189187
* @see \PHPCSUtils\Tokens\Collections::$shortListTokensBC Related property containing only tokens used
190188
* for short lists (cross-version).
191189
*
190+
* @since 1.0.0
191+
*
192192
* @var array <int|string> => <int|string>
193193
*/
194194
public static $listTokensBC = [
@@ -202,10 +202,10 @@ class Collections
202202
/**
203203
* Tokens for the PHP magic constants.
204204
*
205-
* @since 1.0.0
206-
*
207205
* @link https://www.php.net/language.constants.predefined
208206
*
207+
* @since 1.0.0
208+
*
209209
* @var array <int|string> => <int|string>
210210
*/
211211
public static $magicConstants = [
@@ -430,10 +430,10 @@ class Collections
430430
/**
431431
* Tokens which are used for short arrays.
432432
*
433-
* @since 1.0.0
434-
*
435433
* @see \PHPCSUtils\Tokens\Collections::$arrayTokens Related property containing all tokens used for arrays.
436434
*
435+
* @since 1.0.0
436+
*
437437
* @var array <int|string> => <int|string>
438438
*/
439439
public static $shortArrayTokens = [
@@ -447,11 +447,11 @@ class Collections
447447
* List which is backward-compatible with PHPCS < 3.3.0.
448448
* Should only be used selectively.
449449
*
450-
* @since 1.0.0
451-
*
452450
* @see \PHPCSUtils\Tokens\Collections::$arrayTokensBC Related property containing all tokens used for arrays
453451
* (cross-version).
454452
*
453+
* @since 1.0.0
454+
*
455455
* @var array <int|string> => <int|string>
456456
*/
457457
public static $shortArrayTokensBC = [
@@ -464,10 +464,10 @@ class Collections
464464
/**
465465
* Tokens which are used for short lists.
466466
*
467-
* @since 1.0.0
468-
*
469467
* @see \PHPCSUtils\Tokens\Collections::$listTokens Related property containing all tokens used for lists.
470468
*
469+
* @since 1.0.0
470+
*
471471
* @var array <int|string> => <int|string>
472472
*/
473473
public static $shortListTokens = [
@@ -481,11 +481,11 @@ class Collections
481481
* List which is backward-compatible with PHPCS < 3.3.0.
482482
* Should only be used selectively.
483483
*
484-
* @since 1.0.0
485-
*
486484
* @see \PHPCSUtils\Tokens\Collections::$listTokensBC Related property containing all tokens used for lists
487485
* (cross-version).
488486
*
487+
* @since 1.0.0
488+
*
489489
* @var array <int|string> => <int|string>
490490
*/
491491
public static $shortListTokensBC = [

PHPCSUtils/Utils/FunctionDeclarations.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,13 +134,13 @@ class FunctionDeclarations
134134
*
135135
* Alias for the {@see \PHPCSUtils\Utils\ObjectDeclarations::getName()} method.
136136
*
137-
* @codeCoverageIgnore
138-
*
139137
* @see \PHPCSUtils\BackCompat\BCFile::getDeclarationName() Original function.
140138
* @see \PHPCSUtils\Utils\ObjectDeclarations::getName() PHPCSUtils native improved version.
141139
*
142140
* @since 1.0.0
143141
*
142+
* @codeCoverageIgnore
143+
*
144144
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
145145
* @param int $stackPtr The position of the declaration token
146146
* which declared the function.
@@ -954,15 +954,15 @@ public static function isPHPDoubleUnderscoreMethodName($name)
954954
/**
955955
* Checks if a given function is a magic method or a PHP native double underscore method.
956956
*
957+
* {@internal Not the most efficient way of checking this, but less efficient ways will get
958+
* less reliable results or introduce a lot of code duplication.}
959+
*
957960
* @see \PHPCSUtils\Utils\FunctionDeclaration::isSpecialMethodName() For when you already know the name of the
958961
* method and scope checking is done in the
959962
* sniff.
960963
*
961964
* @since 1.0.0
962965
*
963-
* {@internal Not the most efficient way of checking this, but less efficient ways will get
964-
* less reliable results or introduce a lot of code duplication.}
965-
*
966966
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file where this token was found.
967967
* @param int $stackPtr The T_FUNCTION token to check.
968968
*

0 commit comments

Comments
 (0)