Docs: Miscellaneous docblock code quality tweaks.

See #32246

Built from https://develop.svn.wordpress.org/trunk@36074


git-svn-id: http://core.svn.wordpress.org/trunk@36039 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2015-12-23 07:53:26 +00:00
parent 7e43e20436
commit 0003a004db
10 changed files with 17 additions and 13 deletions

View File

@ -834,7 +834,7 @@ class WP_Http {
* This does not verify if the IP is a valid IP, only that it appears to be * This does not verify if the IP is a valid IP, only that it appears to be
* an IP address. * an IP address.
* *
* @see http://home.deds.nl/~aeron/regex/ for IPv6 regex * @link http://home.deds.nl/~aeron/regex/ for IPv6 regex
* *
* @since 3.7.0 * @since 3.7.0
* @static * @static

View File

@ -1229,7 +1229,7 @@ function wp_comment_form_unfiltered_html_nonce() {
* default theme. If either does not exist, then the WordPress process will be * default theme. If either does not exist, then the WordPress process will be
* halted. It is advised for that reason, that the default theme is not deleted. * halted. It is advised for that reason, that the default theme is not deleted.
* *
* @uses $withcomments Will not try to get the comments if the post has none. * Will not try to get the comments if the post has none.
* *
* @since 1.5.0 * @since 1.5.0
* *
@ -1242,6 +1242,7 @@ function wp_comment_form_unfiltered_html_nonce() {
* @global int $user_ID * @global int $user_ID
* @global string $user_identity * @global string $user_identity
* @global bool $overridden_cpage * @global bool $overridden_cpage
* @global bool $withcomments
* *
* @param string $file Optional. The file to load. Default '/comments.php'. * @param string $file Optional. The file to load. Default '/comments.php'.
* @param bool $separate_comments Optional. Whether to separate the comments by comment type. * @param bool $separate_comments Optional. Whether to separate the comments by comment type.

View File

@ -2356,8 +2356,8 @@ function update_usermeta( $user_id, $meta_key, $meta_value ) {
* @deprecated 3.1.0 Use get_users() * @deprecated 3.1.0 Use get_users()
* @see get_users() * @see get_users()
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* @uses $blog_id The Blog id of the blog for those that use more than one blog * @global int $blog_id The Blog id of the blog for those that use more than one blog
* *
* @param int $id Blog ID. * @param int $id Blog ID.
* @return array List of users that are part of that Blog ID * @return array List of users that are part of that Blog ID

View File

@ -675,8 +675,8 @@ function is_new_day() {
* @since 2.3.0 * @since 2.3.0
* *
* @see _http_build_query() Used to build the query * @see _http_build_query() Used to build the query
* @see http://us2.php.net/manual/en/function.http-build-query.php for more on what * @link http://us2.php.net/manual/en/function.http-build-query.php for more on what
* http_build_query() does. * http_build_query() does.
* *
* @param array $data URL-encode key/value pairs. * @param array $data URL-encode key/value pairs.
* @return string URL-encoded string. * @return string URL-encoded string.

View File

@ -90,7 +90,8 @@ function wp_print_scripts( $handles = false ) {
* *
* Registers a script to be linked later using the wp_enqueue_script() function. * Registers a script to be linked later using the wp_enqueue_script() function.
* *
* @see WP_Dependencies::add(), WP_Dependencies::add_data() * @see WP_Dependencies::add()
* @see WP_Dependencies::add_data()
* *
* @since 2.6.0 * @since 2.6.0
* @since 4.3.0 A return value was added. * @since 4.3.0 A return value was added.
@ -205,7 +206,9 @@ function wp_deregister_script( $handle ) {
* *
* Registers the script if $src provided (does NOT overwrite), and enqueues it. * Registers the script if $src provided (does NOT overwrite), and enqueues it.
* *
* @see WP_Dependencies::add(), WP_Dependencies::add_data(), WP_Dependencies::enqueue() * @see WP_Dependencies::add()
* @see WP_Dependencies::add_data()
* @see WP_Dependencies::enqueue()
* *
* @since 2.6.0 * @since 2.6.0
* *

View File

@ -136,7 +136,8 @@ function wp_deregister_style( $handle ) {
* *
* Registers the style if source provided (does NOT overwrite) and enqueues. * Registers the style if source provided (does NOT overwrite) and enqueues.
* *
* @see WP_Dependencies::add(), WP_Dependencies::enqueue() * @see WP_Dependencies::add()
* @see WP_Dependencies::enqueue()
* @link http://www.w3.org/TR/CSS2/media.html#media-types List of CSS media types. * @link http://www.w3.org/TR/CSS2/media.html#media-types List of CSS media types.
* *
* @since 2.6.0 * @since 2.6.0

View File

@ -2736,7 +2736,7 @@ function wp_default_editor() {
* containing TinyMCE: 'edit_page_form', 'edit_form_advanced' and 'dbx_post_sidebar'. * containing TinyMCE: 'edit_page_form', 'edit_form_advanced' and 'dbx_post_sidebar'.
* See https://core.trac.wordpress.org/ticket/19173 for more information. * See https://core.trac.wordpress.org/ticket/19173 for more information.
* *
* @see wp-includes/class-wp-editor.php * @see _WP_Editors::editor()
* @since 3.3.0 * @since 3.3.0
* *
* @param string $content Initial content for the editor. * @param string $content Initial content for the editor.

View File

@ -1517,7 +1517,7 @@ class WP_Query {
* @type string $meta_compare Comparison operator to test the 'meta_value'. * @type string $meta_compare Comparison operator to test the 'meta_value'.
* @type string $meta_key Custom field key. * @type string $meta_key Custom field key.
* @type array $meta_query An associative array of WP_Meta_Query arguments. * @type array $meta_query An associative array of WP_Meta_Query arguments.
* {@see WP_Meta_Query->queries} * {@see WP_Meta_Query}
* @type string $meta_value Custom field value. * @type string $meta_value Custom field value.
* @type int $meta_value_num Custom field value number. * @type int $meta_value_num Custom field value number.
* @type int $menu_order The menu order of the posts. * @type int $menu_order The menu order of the posts.

View File

@ -339,7 +339,6 @@ function wp_update_plugins( $extra_stats = array() ) {
* installing. * installing.
* *
* @since 2.7.0 * @since 2.7.0
* @uses $wp_version Used to notify the WordPress version.
* *
* @param array $extra_stats Extra statistics to report to the WordPress.org API. * @param array $extra_stats Extra statistics to report to the WordPress.org API.
*/ */

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.5-alpha-36073'; $wp_version = '4.5-alpha-36074';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.