Skip to content

Commit d84144d

Browse files
jrfnljrfnl
authored
Merge pull request #57 from PHPCSStandards/feature/file-improve-get-method-return-array-docs
File: improve documentation
2 parents 3f769b9 + 2dfd912 commit d84144d

File tree

1 file changed

+46
-46
lines changed

1 file changed

+46
-46
lines changed

‎src/Files/File.php‎

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1303,25 +1303,25 @@ public function getDeclarationName($stackPtr)
13031303
*
13041304
* <code>
13051305
* 0 => array(
1306-
* 'name' => '$var', // The variable name.
1307-
* 'token' => integer, // The stack pointer to the variable name.
1308-
* 'content' => string, // The full content of the variable definition.
1309-
* 'has_attributes' => boolean, // Does the parameter have one or more attributes attached ?
1310-
* 'pass_by_reference' => boolean, // Is the variable passed by reference?
1311-
* 'reference_token' => integer, // The stack pointer to the reference operator
1312-
* // or FALSE if the param is not passed by reference.
1313-
* 'variable_length' => boolean, // Is the param of variable length through use of `...` ?
1314-
* 'variadic_token' => integer, // The stack pointer to the ... operator
1315-
* // or FALSE if the param is not variable length.
1316-
* 'type_hint' => string, // The type hint for the variable.
1317-
* 'type_hint_token' => integer, // The stack pointer to the start of the type hint
1318-
* // or FALSE if there is no type hint.
1319-
* 'type_hint_end_token' => integer, // The stack pointer to the end of the type hint
1320-
* // or FALSE if there is no type hint.
1321-
* 'nullable_type' => boolean, // TRUE if the type is preceded by the nullability
1322-
* // operator.
1323-
* 'comma_token' => integer, // The stack pointer to the comma after the param
1324-
* // or FALSE if this is the last param.
1306+
* 'name' => string, // The variable name.
1307+
* 'token' => integer, // The stack pointer to the variable name.
1308+
* 'content' => string, // The full content of the variable definition.
1309+
* 'has_attributes' => boolean, // Does the parameter have one or more attributes attached ?
1310+
* 'pass_by_reference' => boolean, // Is the variable passed by reference?
1311+
* 'reference_token' => integer|false, // The stack pointer to the reference operator
1312+
* // or FALSE if the param is not passed by reference.
1313+
* 'variable_length' => boolean, // Is the param of variable length through use of `...` ?
1314+
* 'variadic_token' => integer|false, // The stack pointer to the ... operator
1315+
* // or FALSE if the param is not variable length.
1316+
* 'type_hint' => string, // The type hint for the variable.
1317+
* 'type_hint_token' => integer|false, // The stack pointer to the start of the type hint
1318+
* // or FALSE if there is no type hint.
1319+
* 'type_hint_end_token' => integer|false, // The stack pointer to the end of the type hint
1320+
* // or FALSE if there is no type hint.
1321+
* 'nullable_type' => boolean, // TRUE if the type is preceded by the nullability
1322+
* // operator.
1323+
* 'comma_token' => integer|false, // The stack pointer to the comma after the param
1324+
* // or FALSE if this is the last param.
13251325
* )
13261326
* </code>
13271327
*
@@ -1614,19 +1614,19 @@ public function getMethodParameters($stackPtr)
16141614
* The format of the return value is:
16151615
* <code>
16161616
* array(
1617-
* 'scope' => 'public', // Public, private, or protected
1618-
* 'scope_specified' => true, // TRUE if the scope keyword was found.
1619-
* 'return_type' => '', // The return type of the method.
1620-
* 'return_type_token' => integer, // The stack pointer to the start of the return type
1621-
* // or FALSE if there is no return type.
1622-
* 'return_type_end_token' => integer, // The stack pointer to the end of the return type
1623-
* // or FALSE if there is no return type.
1624-
* 'nullable_return_type' => false, // TRUE if the return type is preceded by the
1625-
* // nullability operator.
1626-
* 'is_abstract' => false, // TRUE if the abstract keyword was found.
1627-
* 'is_final' => false, // TRUE if the final keyword was found.
1628-
* 'is_static' => false, // TRUE if the static keyword was found.
1629-
* 'has_body' => false, // TRUE if the method has a body
1617+
* 'scope' => string, // Public, private, or protected
1618+
* 'scope_specified' => boolean, // TRUE if the scope keyword was found.
1619+
* 'return_type' => string, // The return type of the method.
1620+
* 'return_type_token' => integer|false, // The stack pointer to the start of the return type
1621+
* // or FALSE if there is no return type.
1622+
* 'return_type_end_token' => integer|false, // The stack pointer to the end of the return type
1623+
* // or FALSE if there is no return type.
1624+
* 'nullable_return_type' => boolean, // TRUE if the return type is preceded by the
1625+
* // nullability operator.
1626+
* 'is_abstract' => boolean, // TRUE if the abstract keyword was found.
1627+
* 'is_final' => boolean, // TRUE if the final keyword was found.
1628+
* 'is_static' => boolean, // TRUE if the static keyword was found.
1629+
* 'has_body' => boolean, // TRUE if the method has a body
16301630
* );
16311631
* </code>
16321632
*
@@ -1789,17 +1789,17 @@ public function getMethodProperties($stackPtr)
17891789
*
17901790
* <code>
17911791
* array(
1792-
* 'scope' => string, // Public, private, or protected.
1793-
* 'scope_specified' => boolean, // TRUE if the scope was explicitly specified.
1794-
* 'is_static' => boolean, // TRUE if the static keyword was found.
1795-
* 'is_readonly' => boolean, // TRUE if the readonly keyword was found.
1796-
* 'type' => string, // The type of the var (empty if no type specified).
1797-
* 'type_token' => integer, // The stack pointer to the start of the type
1798-
* // or FALSE if there is no type.
1799-
* 'type_end_token' => integer, // The stack pointer to the end of the type
1800-
* // or FALSE if there is no type.
1801-
* 'nullable_type' => boolean, // TRUE if the type is preceded by the nullability
1802-
* // operator.
1792+
* 'scope' => string, // Public, private, or protected.
1793+
* 'scope_specified' => boolean, // TRUE if the scope was explicitly specified.
1794+
* 'is_static' => boolean, // TRUE if the static keyword was found.
1795+
* 'is_readonly' => boolean, // TRUE if the readonly keyword was found.
1796+
* 'type' => string, // The type of the var (empty if no type specified).
1797+
* 'type_token' => integer|false, // The stack pointer to the start of the type
1798+
* // or FALSE if there is no type.
1799+
* 'type_end_token' => integer|false, // The stack pointer to the end of the type
1800+
* // or FALSE if there is no type.
1801+
* 'nullable_type' => boolean, // TRUE if the type is preceded by the nullability
1802+
* // operator.
18031803
* );
18041804
* </code>
18051805
*
@@ -1977,9 +1977,9 @@ public function getMemberProperties($stackPtr)
19771977
* The format of the return value is:
19781978
* <code>
19791979
* array(
1980-
* 'is_abstract' => false, // true if the abstract keyword was found.
1981-
* 'is_final' => false, // true if the final keyword was found.
1982-
* 'is_readonly' => false, // true if the readonly keyword was found.
1980+
* 'is_abstract' => boolean, // TRUE if the abstract keyword was found.
1981+
* 'is_final' => boolean, // TRUE if the final keyword was found.
1982+
* 'is_readonly' => boolean, // TRUE if the readonly keyword was found.
19831983
* );
19841984
* </code>
19851985
*

0 commit comments

Comments
 (0)