Documentation fixes. See #18560.

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


git-svn-id: http://svn.automattic.com/wordpress/trunk@18753 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
duck_ 2011-09-22 12:02:31 +00:00
parent b816f54124
commit 4a6513185a
3 changed files with 8 additions and 6 deletions

View File

@ -33,9 +33,9 @@ class WP_Editor {
/** /**
* Outputs the HTML and enqueues the JavaScript for a single instance of the editor. * Outputs the HTML and enqueues the JavaScript for a single instance of the editor.
* *
* @param $content The initial content of the editor. * @param string $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 string $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 array $settings See below for description.
*/ */
function editor( $content, $editor_id, $settings = array() ) { function editor( $content, $editor_id, $settings = array() ) {

View File

@ -5195,7 +5195,7 @@ function set_post_thumbnail( $post, $thumbnail_id ) {
* *
* @since 3.1.0 * @since 3.1.0
* *
* @param $format string Post format * @param string $format Post format
* @return string Link * @return string Link
*/ */
function get_post_format_link( $format ) { function get_post_format_link( $format ) {

View File

@ -555,6 +555,7 @@ class wpdb {
* @since 2.5.0 * @since 2.5.0
* *
* @param string $prefix Alphanumeric name for the new prefix. * @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 * @return string|WP_Error Old prefix or WP_Error on error
*/ */
function set_prefix( $prefix, $set_table_names = true ) { function set_prefix( $prefix, $set_table_names = true ) {
@ -726,7 +727,7 @@ class wpdb {
* @param resource $dbh Optional link identifier. * @param resource $dbh Optional link identifier.
* @return null Always null. * @return null Always null.
*/ */
function select( $db, $dbh = null) { function select( $db, $dbh = null ) {
if ( is_null($dbh) ) if ( is_null($dbh) )
$dbh = $this->dbh; $dbh = $this->dbh;
@ -1178,6 +1179,7 @@ class wpdb {
* @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped). * @param array $data Data to insert (in column => value pairs). Both $data columns and $data values should be "raw" (neither should be SQL escaped).
* @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. * @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. * 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. * @return int|false The number of rows affected, or false on error.
*/ */
function _insert_replace_helper( $table, $data, $format = null, $type = 'INSERT' ) { function _insert_replace_helper( $table, $data, $format = null, $type = 'INSERT' ) {
@ -1217,7 +1219,7 @@ class wpdb {
* @param array $where A named array of WHERE clauses (in column => value pairs). Multiple clauses will be joined with ANDs. Both $where columns and $where values should be "raw". * @param array $where A named array of WHERE clauses (in column => value pairs). Multiple clauses will be joined with ANDs. Both $where columns and $where values should be "raw".
* @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. * @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. * 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. * @return int|false The number of rows updated, or false on error.
*/ */
function update( $table, $data, $where, $format = null, $where_format = null ) { function update( $table, $data, $where, $format = null, $where_format = null ) {