Escape dollar signs in PHPDoc callback signatures for proper rendering in IDEs and consistency with official documentation.

Author: isfedorov

PDO/PDO.php

@@ -421,7 +421,7 @@ class PDO
          * <p>
          * using <b>PDO::ATTR_DRIVER_NAME</b>
          * <code>
-         * if ($db->getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') {
+         * if (\$db->getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') {
          * echo "Running on mysql; doing something mysql specific here\n";
          * }
          * </code>
@@ -590,11 +590,11 @@ class PDO
          * <p>
          * Forcing queries to be buffered in mysql
          * <code>
-         * if ($db->getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') {
-         * $stmt = $db->prepare('select * from foo',
+         * if (\$db->getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') {
+         * \$stmt = \$db->prepare('select * from foo',
          * array(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true));
          * } else {
-         * die("my application only works with mysql; I should use \$stmt->fetchAll() instead");
+         * die("my application only works with mysql; I should use \\$stmt->fetchAll() instead");
          * }
          * </code>
          * </p>
@@ -1198,7 +1198,7 @@ public function setAttribute(
          * <b>PDO::exec</b>, wherein a statement that affected 0 rows
          * results in a call to <b>die</b>:
          * <code>
-         * $db->exec() or die(print_r($db->errorInfo(), true));
+         * \$db->exec() or die(print_r(\$db->errorInfo(), true));
          * </code>
          * @throws PDOException On error if PDO::ERRMODE_EXCEPTION option is true.
          */
@@ -2269,23 +2269,23 @@ class Sqlite extends PDO
          * @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:
-         * <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
+         * <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/>\$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:
-         * <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.
+         * <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
@@ -2328,9 +2328,9 @@ public function createCollation(string $name, callable $callback): bool {}
          * @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:
-         * <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.
+         * <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