Skip to content

Commit be5942a

Browse files
jrfnljrfnl
authored
Merge pull request #634 from PHPCSStandards/feature/bctokens-collections-improve-method-tags
Docs: improve specificity
2 parents e7c1d70 + 301e2d3 commit be5942a

File tree

2 files changed

+78
-60
lines changed

2 files changed

+78
-60
lines changed

‎PHPCSUtils/BackCompat/BCTokens.php‎

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -43,31 +43,33 @@
4343
*
4444
* @since 1.0.0
4545
*
46-
* @method static array arithmeticTokens() Tokens that represent arithmetic operators.
47-
* @method static array assignmentTokens() Tokens that represent assignments.
48-
* @method static array blockOpeners() Tokens that open code blocks.
49-
* @method static array booleanOperators() Tokens that perform boolean operations.
50-
* @method static array bracketTokens() Tokens that represent brackets and parenthesis.
51-
* @method static array castTokens() Tokens that represent type casting.
52-
* @method static array commentTokens() Tokens that are comments.
53-
* @method static array comparisonTokens() Tokens that represent comparison operator.
54-
* @method static array contextSensitiveKeywords() Tokens representing context sensitive keywords in PHP.
55-
* @method static array emptyTokens() Tokens that don't represent code.
56-
* @method static array equalityTokens() Tokens that represent equality comparisons.
57-
* @method static array heredocTokens() Tokens that make up a heredoc string.
58-
* @method static array includeTokens() Tokens that include files.
59-
* @method static array magicConstants() Tokens representing PHP magic constants.
60-
* @method static array methodPrefixes() Tokens that can prefix a method name.
61-
* @method static array ooScopeTokens() Tokens that open class and object scopes.
62-
* @method static array operators() Tokens that perform operations.
63-
* @method static array parenthesisOpeners() Token types that open parenthesis.
64-
* @method static array phpcsCommentTokens() Tokens that are comments containing PHPCS instructions.
65-
* @method static array scopeModifiers() Tokens that represent scope modifiers.
66-
* @method static array scopeOpeners() Tokens that are allowed to open scopes.
67-
* @method static array stringTokens() Tokens that represent strings.
68-
* Note that `T_STRING`s are NOT represented in this list as this list
69-
* is about _text_ strings.
70-
* @method static array textStringTokens() Tokens that represent text strings.
46+
* @method static array<int|string, int|string> arithmeticTokens() Tokens that represent arithmetic operators.
47+
* @method static array<int|string, int|string> assignmentTokens() Tokens that represent assignments.
48+
* @method static array<int|string, int|string> blockOpeners() Tokens that open code blocks.
49+
* @method static array<int|string, int|string> booleanOperators() Tokens that perform boolean operations.
50+
* @method static array<int|string, int|string> bracketTokens() Tokens that represent brackets and parenthesis.
51+
* @method static array<int|string, int|string> castTokens() Tokens that represent type casting.
52+
* @method static array<int|string, int|string> commentTokens() Tokens that are comments.
53+
* @method static array<int|string, int|string> comparisonTokens() Tokens that represent comparison operator.
54+
* @method static array<int|string, int|string> contextSensitiveKeywords() Tokens representing context sensitive keywords
55+
* in PHP.
56+
* @method static array<int|string, int|string> emptyTokens() Tokens that don't represent code.
57+
* @method static array<int|string, int|string> equalityTokens() Tokens that represent equality comparisons.
58+
* @method static array<int|string, int|string> heredocTokens() Tokens that make up a heredoc string.
59+
* @method static array<int|string, int|string> includeTokens() Tokens that include files.
60+
* @method static array<int|string, int|string> magicConstants() Tokens representing PHP magic constants.
61+
* @method static array<int|string, int|string> methodPrefixes() Tokens that can prefix a method name.
62+
* @method static array<int|string, int|string> ooScopeTokens() Tokens that open class and object scopes.
63+
* @method static array<int|string, int|string> operators() Tokens that perform operations.
64+
* @method static array<int|string, int|string> parenthesisOpeners() Token types that open parenthesis.
65+
* @method static array<int|string, int|string> phpcsCommentTokens() Tokens that are comments containing PHPCS
66+
* instructions.
67+
* @method static array<int|string, int|string> scopeModifiers() Tokens that represent scope modifiers.
68+
* @method static array<int|string, int|string> scopeOpeners() Tokens that are allowed to open scopes.
69+
* @method static array<int|string, int|string> stringTokens() Tokens that represent strings.
70+
* Note that `T_STRING`s are NOT represented in this
71+
* list as this list is about _text_ strings.
72+
* @method static array<int|string, int|string> textStringTokens() Tokens that represent text strings.
7173
*/
7274
final class BCTokens
7375
{

‎PHPCSUtils/Tokens/Collections.php‎

Lines changed: 51 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -23,41 +23,57 @@
2323
*
2424
* @since 1.0.0
2525
*
26-
* @method static array alternativeControlStructureSyntaxes() Tokens for control structures which can use the
27-
* alternative control structure syntax.
28-
* @method static array alternativeControlStructureSyntaxClosers() Tokens representing alternative control structure
29-
* syntax closer keywords.
30-
* @method static array arrayTokens() Tokens which are used to create arrays.
31-
* @method static array classModifierKeywords() Modifier keywords which can be used for a class
32-
* declaration.
33-
* @method static array closedScopes() List of tokens which represent "closed" scopes.
34-
* @method static array constantModifierKeywords() Tokens which can be used as modifiers for a constant
35-
* declaration (in OO structures).
36-
* @method static array controlStructureTokens() Control structure tokens.
37-
* @method static array functionDeclarationTokens() Tokens which represent a keyword which starts
38-
* a function declaration.
39-
* @method static array incrementDecrementOperators() Increment/decrement operator tokens.
40-
* @method static array listTokens() Tokens which are used to create lists.
41-
* @method static array namespaceDeclarationClosers() List of tokens which can end a namespace
42-
* declaration statement.
43-
* @method static array nameTokens() Tokens used for "names", be it namespace, OO,
44-
* function
45-
* or constant names.
46-
* @method static array objectOperators() Object operator tokens.
47-
* @method static array ooCanExtend() OO structures which can use the "extends" keyword.
48-
* @method static array ooCanImplement() OO structures which can use the "implements" keyword.
49-
* @method static array ooConstantScopes() OO scopes in which constants can be declared.
50-
* @method static array ooHierarchyKeywords() Tokens types used for "forwarding" calls within
51-
* OO structures.
52-
* @method static array ooPropertyScopes() OO scopes in which properties can be declared.
53-
* @method static array phpOpenTags() Tokens which open PHP.
54-
* @method static array propertyModifierKeywords() Modifier keywords which can be used for a property
55-
* declaration.
56-
* @method static array shortArrayTokens() Tokens which are used for short arrays.
57-
* @method static array shortListTokens() Tokens which are used for short lists.
58-
* @method static array ternaryOperators() Tokens which represent ternary operators.
59-
* @method static array textStringStartTokens() Tokens which can start a - potentially multi-line -
60-
* text string.
26+
* @method static array<int|string, int|string> alternativeControlStructureSyntaxes() Tokens for control structures
27+
* which can use the alternative
28+
* control structure syntax.
29+
* @method static array<int|string, int|string> alternativeControlStructureSyntaxClosers() Tokens representing alternative
30+
* control structure syntax closer
31+
* keywords.
32+
* @method static array<int|string, int|string> arrayTokens() Tokens which are used to create
33+
* arrays.
34+
* @method static array<int|string, int|string> classModifierKeywords() Modifier keywords which can be
35+
* used for a class declaration.
36+
* @method static array<int|string, int|string> closedScopes() List of tokens which represent
37+
* "closed" scopes.
38+
* @method static array<int|string, int|string> constantModifierKeywords() Tokens which can be used as
39+
* modifiers for a constant
40+
* declaration (in OO structures).
41+
* @method static array<int|string, int|string> controlStructureTokens() Control structure tokens.
42+
* @method static array<int|string, int|string> functionDeclarationTokens() Tokens which represent a keyword
43+
* which starts a function
44+
* declaration.
45+
* @method static array<int|string, int|string> incrementDecrementOperators() Increment/decrement operator
46+
* tokens.
47+
* @method static array<int|string, int|string> listTokens() Tokens which are used to create
48+
* lists.
49+
* @method static array<int|string, int|string> namespaceDeclarationClosers() List of tokens which can end a
50+
* namespace declaration statement.
51+
* @method static array<int|string, int|string> nameTokens() Tokens used for "names", be it
52+
* namespace, OO, function or
53+
* constant names.
54+
* @method static array<int|string, int|string> objectOperators() Object operator tokens.
55+
* @method static array<int|string, int|string> ooCanExtend() OO structures which can use the
56+
* "extends" keyword.
57+
* @method static array<int|string, int|string> ooCanImplement() OO structures which can use the
58+
* "implements" keyword.
59+
* @method static array<int|string, int|string> ooConstantScopes() OO scopes in which constants can
60+
* be declared.
61+
* @method static array<int|string, int|string> ooHierarchyKeywords() Tokens types used for "forwarding"
62+
* calls within OO structures.
63+
* @method static array<int|string, int|string> ooPropertyScopes() OO scopes in which properties can
64+
* be declared.
65+
* @method static array<int|string, int|string> phpOpenTags() Tokens which open PHP.
66+
* @method static array<int|string, int|string> propertyModifierKeywords() Modifier keywords which can be
67+
* used for a property declaration.
68+
* @method static array<int|string, int|string> shortArrayTokens() Tokens which are used for
69+
* short arrays.
70+
* @method static array<int|string, int|string> shortListTokens() Tokens which are used for
71+
* short lists.
72+
* @method static array<int|string, int|string> ternaryOperators() Tokens which represent ternary
73+
* operators.
74+
* @method static array<int|string, int|string> textStringStartTokens() Tokens which can start a
75+
* - potentially multi-line -
76+
* text string.
6177
*/
6278
final class Collections
6379
{

0 commit comments

Comments
 (0)