Align PHPDoc @param and callback signatures with official PHP documentation, improving clarity and consistency across stubs.

Author: isfedorov

PDO/PDO.php

@@ -2268,21 +2268,26 @@ class Sqlite extends PDO
          * @param string $name The name of the function used in SQL statements.
          * @param callable $step Callback function called for each row of the result set. The
          * callback should accumulate the result and store it in the aggregation context. This
-         * function need to be defined as: mixedstep mixedcontext intrownumber mixedvalue
-         * mixedvalues context null for the first row; on subsequent rows it will have the value
-         * that was previously returned from the step function; you should use this to maintain the
-         * aggregate state. rownumber The current row number. value The first argument passed to the
-         * aggregate. values Further arguments passed to the aggregate. The return value of this
-         * function will be used as the context argument in the next call of the step or finalize
-         * functions.
+         * function need to be defined as:
+         * <code>step ( mixed $context , int $rownumber , mixed $value , mixed $values ): mixed</code>
+         * <br/>$context - null for the first row; on subsequent rows it will have the value that was
+         * previously returned from the step function; you should use this to maintain the aggregate
+         * state.
+         * <br/>$rownumber - The current row number.
+         * <br/>$value - The first argument passed to the aggregate.
+         * <br/>$values - Further arguments passed to the aggregate.
+         * <br/>The return value of this function will be used as the context argument in the next
+         * call of the step or finalize functions.
          * @param callable $finalize Callback function to aggregate the "stepped" data from each
          * row. Once all the rows have been processed, this function will be called, and it should
          * then take the data from the aggregation context and return the result. This callback
          * function should return a type understood by SQLite (i.e. scalar type). This function need
-         * to be defined as: mixedfini mixedcontext introwcount context Holds the return value from
-         * the very last call to the step function. rowcount Holds the number of rows over which the
-         * aggregate was performed. The return value of this function will be used as the return
-         * value for the aggregate.
+         * to be defined as:
+         * <code>fini ( mixed $context , int $rowcount ): mixed</code>
+         * <br/>$context - Holds the return value from the very last call to the step function.
+         * <br/>$rowcount - Holds the number of rows over which the aggregate was performed.
+         * <br/>The return value of this function will be used as the return value for the
+         * aggregate.
          * @param int $numArgs Hint to the SQLite parser if the callback function accepts a
          * predetermined number of arguments.
          * @return bool Returns true on success or false on failure.
@@ -2322,8 +2327,10 @@ public function createCollation(string $name, callable $callback): bool {}
          * @param string $function_name The name of the function used in SQL statements.
          * @param callable $callback Callback function to handle the defined SQL function. Callback
          * functions should return a type understood by SQLite (i.e. scalar type). This function
-         * need to be defined as: mixedcallback mixedvalue mixedvalues value The first argument
-         * passed to the SQL function. values Further arguments passed to the SQL function.
+         * need to be defined as:
+         * <code>callback ( mixed $value , mixed $values ): mixed</code>
+         * <br/>$value - The first argument passed to the SQL function.
+         * <br/>$values - Further arguments passed to the SQL function.
          * @param int $num_args The number of arguments that the SQL function takes. If this
          * parameter is -1, then the SQL function may take any number of arguments.
          * @param int $flags A bitmask of flags. Currently, only Pdo\Sqlite::DETERMINISTIC is

ds_v2/ds.php

@@ -280,9 +280,10 @@ public function __construct(iterable $values = []) {}
     public function allocate(int $capacity): void {}
 
     /**
-     * @param callable(TKey, TValue): TValue $callback mixed callback mixedkey mixedvalue A callable
-     * to apply to each value in the map. The callback should return what the value should be
-     * replaced by.
+     * @param callable(TKey, TValue): TValue $callback
+     * <code>callback ( mixed $key , mixed $value ): mixed</code>
+     * <br/>A callable to apply to each value in the map. The callback should return what the value
+     * should be replaced by.
      */
     public function apply(callable $callback): void {}
 
@@ -304,9 +305,11 @@ public function count(): int {}
     public function diff(Map $map): Map {}
 
     /**
-     * @param null|callable(TKey, TValue): bool $callback bool callback mixedkey mixedvalue Optional
-     * callable which returns true if the pair should be included, false otherwise. If a callback is
-     * not provided, only values which are true (see converting to boolean) will be included.
+     * @param null|callable(TKey, TValue): bool $callback
+     * <code>callback ( mixed $key , mixed $value ): bool</code>
+     * <br/>Optional callable which returns true if the pair should be included, false otherwise. If
+     * a callback is not provided, only values which are true (see converting to boolean) will be
+     * included.
      * @return Map<TKey, TValue> A new map containing all the pairs for which either the callback
      * returned true, or all values that convert to true if a callback was not provided.
      */
@@ -382,9 +385,10 @@ public function last(): Pair {}
 
     /**
      * @template TReturn
-     * @param callable(TKey, TValue): TReturn $callback mixed callback mixedkey mixedvalue A
-     * callable to apply to each value in the map. The callable should return what the key will be
-     * mapped to in the resulting map.
+     * @param callable(TKey, TValue): TReturn $callback
+     * <code>callback ( mixed $key , mixed $value ): mixed</code>
+     * <br/>A callable to apply to each value in the map. The callable should return what the key
+     * will be mapped to in the resulting map.
      * @return Map<TKey, TReturn> The result of applying a callback to each value in the map. The
      * keys and values of the current instance won't be affected.
      */
@@ -415,10 +419,12 @@ public function putAll($values): void {}
     /**
      * @template TInitial
      * @template TReturn
-     * @param callable(TInitial|TReturn|null, TKey, TValue): TReturn $callback mixedcallback
-     * mixedcarry mixedkey mixedvalue carry The return value of the previous callback, or initial if
-     * it's the first iteration. key The key of the current iteration. value The value of the
-     * current iteration.
+     * @param callable(TInitial|TReturn|null, TKey, TValue): TReturn $callback
+     * <code>callback ( mixed $carry , mixed $key , mixed $value ): mixed</code>
+     * <br/>$carry - The return value of the previous callback, or initial if it's the first
+     * iteration.
+     * <br/>$key - The key of the current iteration.
+     * <br/>$value - The value of the current iteration.
      * @param TInitial|null $initial The initial value of the carry value. Can be null.
      * @return TReturn|null The return value of the final callback.
      */
@@ -591,9 +597,11 @@ public function count(): int {}
     public function diff(Set $set): Set {}
 
     /**
-     * @param null|callable(TValue): bool $callback bool callback mixedvalue Optional callable which
-     * returns true if the value should be included, false otherwise. If a callback is not provided,
-     * only values which are true (see converting to boolean) will be included.
+     * @param null|callable(TValue): bool $callback
+     * <code>callback ( mixed $value ): bool</code>
+     * <br/>Optional callable which returns true if the value should be included, false otherwise.
+     * If a callback is not provided, only values which are true (see converting to boolean) will be
+     * included.
      * @return Set<TValue> A new set containing all the values for which either the callback
      * returned true, or all values that convert to true if a callback was not provided.
      */
@@ -632,7 +640,8 @@ public function last() {}
     /**
      * @template TReturn
      * @param callable(TValue): TReturn $callback The callback to apply to each value in the set
-     * must have the following signature: mixed callback mixedvalue
+     * must have the following signature:
+     * <code>callback ( mixed $value ): mixed</code>
      * @return Set<TReturn> Returns a new Ds\Set instance where each value is the result of applying
      * the callback to each value of the set.
      */
@@ -649,9 +658,11 @@ public function merge($values): Set {}
     /**
      * @template TInitial
      * @template TReturn
-     * @param callable(TInitial|TReturn|null, TValue): TReturn $callback mixedcallback mixedcarry
-     * mixedvalue carry The return value of the previous callback, or initial if it's the first
-     * iteration. value The value of the current iteration.
+     * @param callable(TInitial|TReturn|null, TValue): TReturn $callback
+     * <code>callback ( mixed $carry , mixed $value ): mixed</code>
+     * <br/>$carry - The return value of the previous callback, or initial if it's the first
+     * iteration.
+     * <br/>$value - The value of the current iteration.
      * @param TInitial|null $initial The initial value of the carry value. Can be null.
      * @return TReturn|null The return value of the final callback.
      */

standard/standard_10.php

@@ -10,7 +10,9 @@
  * @template TValue
  * @param array<TKey, TValue> $array The array that should be searched.
  * @param callable(TValue, TKey): bool $callback The callback function to call to check each element, which must be of
- * the following signature: boolcallback mixedvalue mixedkey If this function returns true, the
+ * the following signature:
+ * <code>callback ( mixed $value , mixed $key ): bool</code>
+ * <br/>If this function returns true, the
  * value is returned from array_find and the callback will not be called for further elements.
  * @return TValue|null The function returns the value of the first element for which the callback
  * returns true. If no matching element is found the function returns null.
@@ -26,7 +28,9 @@ function array_find(array $array, callable $callback): mixed {}
  * @template TValue
  * @param array<TKey, TValue> $array The array that should be searched.
  * @param callable(TValue, TKey): bool $callback The callback function to call to check each element, which must be of
- * the following signature: boolcallback mixedvalue mixedkey If this function returns true, the key
+ * the following signature:
+ * <code>callback ( mixed $value , mixed $key ): bool</code>
+ * <br/>If this function returns true, the key
  * is returned from array_find_key and the callback will not be called for further elements.
  * @return TKey|null The function returns the key of the first element for which the callback
  * returns true. If no matching element is found the function returns null.
@@ -44,7 +48,9 @@ function array_find_key(array $array, callable $callback): mixed {}
  * @template TValue
  * @param array<TKey, TValue> $array The array that should be searched.
  * @param callable(TValue, TKey): bool $callback The callback function to call to check each element, which must be of
- * the following signature: boolcallback mixedvalue mixedkey If this function returns true, true is
+ * the following signature:
+ * <code>callback ( mixed $value , mixed $key ): bool</code>
+ * <br/>If this function returns true, true is
  * returned from array_any and the callback will not be called for further elements.
  * @return bool The function returns true, if there is at least one element for which callback
  * returns true. Otherwise the function returns false.
@@ -60,7 +66,9 @@ function array_any(array $array, callable $callback): bool {}
  * @template TValue
  * @param array<TKey, TValue> $array The array that should be searched.
  * @param callable(TValue, TKey): bool $callback The callback function to call to check each element, which must be of
- * the following signature: boolcallback mixedvalue mixedkey If this function returns false, false
+ * the following signature:
+ * <code>callback ( mixed $value , mixed $key ): bool</code>
+ * <br/>If this function returns false, false
  * is returned from array_all and the callback will not be called for further elements.
  * @return bool The function returns true, if callback returns true for all elements. Otherwise the
  * function returns false.