Changeset 28016

Timestamp:

04/07/2014 10:01:37 PM (13 years ago)

Author:

DrewAPicture

Message:

PHPDoc fixes for functionality in wp-includes/wp-db.php added in 3.9.

See #27700.

File:

• trunk/src/wp-includes/wp-db.php (modified) (4 diffs)

trunk/src/wp-includes/wp-db.php

@@ -1300 +1300 @@
          * Connect to and select database.
          *
+         * If $allow_bail is false, the lack of database connection will need
+         * to be handled manually.
+         *
          * @since 3.0.0
-         *
-         * @param bool $allow_bail Optional. Allows the function to bail, default true. If this is set
-         *                         to false, you will need to handle the lack of database connection
-         *                         manually. Available since 3.9.0.
-         *
+         * @since 3.9.0 $allow_bail parameter added.
+         *
+         * @param bool $allow_bail Optional. Allows the function to bail. Default true.
          * @return bool True with a successful connection, false on failure.
          */
@@ -1415 +1416 @@
          * the template_redirect hook has been fired, return false instead.
          *
+         * If $allow_bail is false, the lack of database connection will need
+         * to be handled manually.
+         *
          * @since 3.9.0
          *
-         * @param bool $allow_bail Optional. Allows the function to bail, default true. If this is set
-         *                         to false, you will need to handle the lack of database connection
-         *                         manually.
-         *
+         * @param bool $allow_bail Optional. Allows the function to bail. Default true.
          * @return bool True if the connection is up.
          */
@@ -1599 +1600 @@
 
         /**
-         * Internal function to perform the mysql_query call
+         * Internal function to perform the mysql_query() call.
          *
          * @since 3.9.0
@@ -1606 +1607 @@
          * @see wpdb::query()
          *
-         * @param string $query The query to run
+         * @param string $query The query to run.
          */
         private function _do_query( $query ) {