Changeset 18753

Timestamp:

09/22/2011 12:02:31 PM (15 years ago)

Author:

duck_

Message:

Documentation fixes. See #18560.

• Add missing parameters
• Add missing @param data types
• s/format_where/where_format/

Location:

trunk/wp-includes

Files:

• class-wp-editor.php (modified) (1 diff)
• post.php (modified) (1 diff)
• wp-db.php (modified) (4 diffs)

trunk/wp-includes/class-wp-editor.php

@@ -34 +34 @@
          * Outputs the HTML and enqueues the JavaScript for a single instance of the editor.
          *
-         * @param $content The initial content of the editor.
-         * @param $editor_id ID for the textarea and TinyMCE and Quicktags instances (can contain only ASCII letters and numbers).
-         * @param $settings See below for description.
+         * @param string $content The initial content of the editor.
+         * @param string $editor_id ID for the textarea and TinyMCE and Quicktags instances (can contain only ASCII letters and numbers).
+         * @param array $settings See below for description.
          */
         function editor( $content, $editor_id, $settings = array() ) {

trunk/wp-includes/post.php

@@ -5196 +5196 @@
  * @since 3.1.0
  *
- * @param $format string Post format
+ * @param string $format Post format
  * @return string Link
  */

trunk/wp-includes/wp-db.php

@@ -556 +556 @@
          *
          * @param string $prefix Alphanumeric name for the new prefix.
+         * @param bool $set_table_names Optional. Whether the table names, e.g. wpdb::$posts, should be updated or not.
          * @return string|WP_Error Old prefix or WP_Error on error
          */
@@ -727 +728 @@
          * @return null Always null.
          */
-        function select( $db, $dbh = null) {
+        function select( $db, $dbh = null ) {
                 if ( is_null($dbh) )
                         $dbh = $this->dbh;
@@ -1179 +1180 @@
          * @param array|string $format Optional. An array of formats to be mapped to each of the value in $data. If string, that format will be used for all of the values in $data.
          *      A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
+         * @param string $type Optional. What type of operation is this? INSERT or REPLACE. Defaults to INSERT.
          * @return int|false The number of rows affected, or false on error.
          */
@@ -1218 +1220 @@
          * @param array|string $format Optional. An array of formats to be mapped to each of the values in $data. If string, that format will be used for all of the values in $data.
          *      A format is one of '%d', '%f', '%s' (integer, float, string). If omitted, all values in $data will be treated as strings unless otherwise specified in wpdb::$field_types.
-         * @param array|string $format_where Optional. An array of formats to be mapped to each of the values in $where. If string, that format will be used for all of the items in $where.  A format is one of '%d', '%f', '%s' (integer, float, string).  If omitted, all values in $where will be treated as strings.
+         * @param array|string $where_format Optional. An array of formats to be mapped to each of the values in $where. If string, that format will be used for all of the items in $where.  A format is one of '%d', '%f', '%s' (integer, float, string).  If omitted, all values in $where will be treated as strings.
          * @return int|false The number of rows updated, or false on error.
          */