Docs: update "nullable_type" comments to clarify meaning

PHPCSStandards · Jul 17, 2020 · 38ad2b0 · 38ad2b0
1 parent 6b3bbef
commit 38ad2b0
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 6 deletions.
diff --git a/PHPCSUtils/BackCompat/BCFile.php b/PHPCSUtils/BackCompat/BCFile.php
@@ -204,7 +204,8 @@ public static function getDeclarationName(File $phpcsFile, $stackPtr)
      *                                     // or FALSE if there is no type hint.
      *   'type_hint_end_token' => integer, // The stack pointer to the end of the type hint
      *                                     // or FALSE if there is no type hint.
-     *   'nullable_type'       => boolean, // TRUE if the var type is nullable.
+     *   'nullable_type'       => boolean, // TRUE if the var type is preceded by the nullability
+     *                                     // operator.
      *   'comma_token'         => integer, // The stack pointer to the comma after the param
      *                                     // or FALSE if this is the last param.
      * )
@@ -503,7 +504,8 @@ public static function getMethodParameters(File $phpcsFile, $stackPtr)
      *   'return_type'          => '',       // The return type of the method.
      *   'return_type_token'    => integer,  // The stack pointer to the start of the return type
      *                                       // or FALSE if there is no return type.
-     *   'nullable_return_type' => false,    // TRUE if the return type is nullable.
+     *   'nullable_return_type' => false,    // TRUE if the return type is preceded by
+     *                                       // the nullability operator.
      *   'is_abstract'          => false,    // TRUE if the abstract keyword was found.
      *   'is_final'             => false,    // TRUE if the final keyword was found.
      *   'is_static'            => false,    // TRUE if the static keyword was found.
@@ -712,7 +714,8 @@ public static function getMethodProperties(File $phpcsFile, $stackPtr)
      *                                 // or FALSE if there is no type.
      *   'type_end_token'  => integer, // The stack pointer to the end of the type
      *                                 // or FALSE if there is no type.
-     *   'nullable_type'   => boolean, // TRUE if the type is nullable.
+     *   'nullable_type'   => boolean, // TRUE if the type is preceded by the
+     *                                 // nullability operator.
      * );
      * ```
      *

diff --git a/PHPCSUtils/Utils/FunctionDeclarations.php b/PHPCSUtils/Utils/FunctionDeclarations.php
@@ -195,7 +195,8 @@ public static function getName(File $phpcsFile, $stackPtr)
      *                                                      // or FALSE if there is no return type.
      *                 'return_type_end_token' => integer,  // The stack pointer to the end of the return type
      *                                                      // or FALSE if there is no return type.
-     *                 'nullable_return_type'  => false,    // TRUE if the return type is nullable.
+     *                 'nullable_return_type'  => false,    // TRUE if the return type is preceded
+     *                                                      // by the nullability operator.
      *                 'is_abstract'           => false,    // TRUE if the abstract keyword was found.
      *                 'is_final'              => false,    // TRUE if the final keyword was found.
      *                 'is_static'             => false,    // TRUE if the static keyword was found.
@@ -361,7 +362,8 @@ public static function getProperties(File $phpcsFile, $stackPtr)
      *                                     // or FALSE if there is no type hint.
      *   'type_hint_end_token' => integer, // The stack pointer to the end of the type hint
      *                                     // or FALSE if there is no type hint.
-     *   'nullable_type'       => boolean, // TRUE if the var type is nullable.
+     *   'nullable_type'       => boolean, // TRUE if the var type is preceded by the nullability
+     *                                     // operator.
      *   'comma_token'         => integer, // The stack pointer to the comma after the param
      *                                     // or FALSE if this is the last param.
      * )

diff --git a/PHPCSUtils/Utils/Variables.php b/PHPCSUtils/Utils/Variables.php
@@ -104,7 +104,8 @@ class Variables
      *                                               // or FALSE if there is no type.
      *                 'type_end_token'  => integer, // The stack pointer to the end of the type
      *                                               // or FALSE if there is no type.
-     *                 'nullable_type'   => boolean, // TRUE if the type is nullable.
+     *                 'nullable_type'   => boolean, // TRUE if the type is preceded by the
+     *                                               // nullability operator.
      *               );
      *               ```
      *