docs: improve doc comments

codeigniter4 · Feb 2, 2024 · 6d971af · 6d971af
1 parent eb88917
commit 6d971af
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 12 deletions.
diff --git a/system/Database/BaseResult.php b/system/Database/BaseResult.php
@@ -252,14 +252,16 @@ public function getResultObject(): array
      * Wrapper object to return a row as either an array, an object, or
      * a custom class.
      *
-     * If row doesn't exist, returns null.
+     * If the row doesn't exist, returns null.
+     *
+     * @template T of object
      *
-     * @param         int|string                    $n    The index of the results to return, or column name.
-     * @param         string                        $type The type of result object. 'array', 'object' or class name.
-     * @phpstan-param class-string|'array'|'object' $type
+     * @param         int|string                       $n    The index of the results to return, or column name.
+     * @param         string                           $type The type of result object. 'array', 'object' or class name.
+     * @phpstan-param class-string<T>|'array'|'object' $type
      *
      * @return         array|object|stdClass|null
-     * @phpstan-return ($type is 'object' ? stdClass|null : ($type is 'array' ? array|null : object|null))
+     * @phpstan-return ($type is 'object' ? stdClass|null : ($type is 'array' ? array|null : T|null))
      */
     public function getRow($n = 0, string $type = 'object')
     {
@@ -296,7 +298,7 @@ public function getRow($n = 0, string $type = 'object')
      *
      * @template T of object
      *
-     * @param         int             $n         The row number of the results
+     * @param         int             $n         The index of the results to return.
      * @phpstan-param class-string<T> $className
      *
      * @return         object|null

diff --git a/system/Database/ResultInterface.php b/system/Database/ResultInterface.php
@@ -55,14 +55,16 @@ public function getResultObject(): array;
      * Wrapper object to return a row as either an array, an object, or
      * a custom class.
      *
-     * If row doesn't exist, returns null.
+     * If the row doesn't exist, returns null.
+     *
+     * @template T of object
      *
-     * @param         int|string                    $n    The index of the results to return, or column name.
-     * @param         string                        $type The type of result object. 'array', 'object' or class name.
-     * @phpstan-param class-string|'array'|'object' $type
+     * @param         int|string                       $n    The index of the results to return, or column name.
+     * @param         string                           $type The type of result object. 'array', 'object' or class name.
+     * @phpstan-param class-string<T>|'array'|'object' $type
      *
      * @return         array|object|stdClass|null
-     * @phpstan-return ($type is 'object' ? stdClass|null : ($type is 'array' ? array|null : object|null))
+     * @phpstan-return ($type is 'object' ? stdClass|null : ($type is 'array' ? array|null : T|null))
      */
     public function getRow($n = 0, string $type = 'object');
 
@@ -73,7 +75,7 @@ public function getRow($n = 0, string $type = 'object');
      *
      * @template T of object
      *
-     * @param         int             $n         The row number of the results
+     * @param         int             $n         The index of the results to return.
      * @phpstan-param class-string<T> $className
      *
      * @return         object|null