Changeset 30624 for trunk/src/wp-includes/wp-db.php

Timestamp:

11/28/2014 12:33:16 PM (10 years ago)

Author:

DrewAPicture

Message:

4.1 Docs Audit: Improve inline documentation for various wpdb methods.

#30469.

File:

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

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

@@ -1965 +1965 @@
 
     /**
-     * Adds field charsets to field/value/format arrays
-     * generated by the process_field_formats() method.
+     * Adds field charsets to field/value/format arrays generated by
+     * the {@see wpdb::process_field_formats()} method.
      *
      * @since 4.1.0
      * @access protected
      *
-     * @param array  $data  As it comes from the process_field_formats() method.
+     * @param array  $data  As it comes from the {@see wpdb::process_field_formats()} method.
      * @param string $table Table name.
      * @return The same array as $data with additional 'charset' keys.
@@ -2162 +2162 @@
      *
      * @param string $table Table name.
-     * @return string|WP_Error Table character set, `WP_Error` object if it couldn't be found.
+     * @return string|WP_Error Table character set, {@see WP_Error} object if it couldn't be found.
      */
     protected function get_table_charset( $table ) {
@@ -2255 +2255 @@
      * @param string $table  Table name.
      * @param string $column Column name.
-     * @return mixed Column character set as a string.
-     *               False if the column has no character set.
-     *               `WP_Error` object if there was an error.
+     * @return mixed Column character set as a string. False if the column has no
+     *               character set. {@see WP_Error} object if there was an error.
      */
     protected function get_col_charset( $table, $column ) {
@@ -2348 +2347 @@
      *                        each value. This works as a passthrough: any additional keys
      *                        such as 'field' are retained in each value array. If we cannot
-     *                        remove invalid characters, a `WP_Error` object is returned.
+     *                        remove invalid characters, a {@see WP_Error} object is returned.
      */
     protected function strip_invalid_text( $data ) {
@@ -2470 +2469 @@
      *
      * @param string $query Query to convert.
-     * @return string|WP_Error The converted query, or a `WP_Error` object if the conversion fails.
+     * @return string|WP_Error The converted query, or a {@see WP_Error} object if the conversion fails.
      */
     protected function strip_invalid_text_from_query( $query ) {