From 0003a004db1fa4a602dd2b0e7694d770b8962f63 Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Wed, 23 Dec 2015 07:53:26 +0000 Subject: [PATCH] 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 --- wp-includes/class-http.php | 2 +- wp-includes/comment-template.php | 3 ++- wp-includes/deprecated.php | 4 ++-- wp-includes/functions.php | 4 ++-- wp-includes/functions.wp-scripts.php | 7 +++++-- wp-includes/functions.wp-styles.php | 3 ++- wp-includes/general-template.php | 2 +- wp-includes/query.php | 2 +- wp-includes/update.php | 1 - wp-includes/version.php | 2 +- 10 files changed, 17 insertions(+), 13 deletions(-) diff --git a/wp-includes/class-http.php b/wp-includes/class-http.php index 98fda58623..d947bcac1b 100644 --- a/wp-includes/class-http.php +++ b/wp-includes/class-http.php @@ -834,7 +834,7 @@ class WP_Http { * This does not verify if the IP is a valid IP, only that it appears to be * 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 * @static diff --git a/wp-includes/comment-template.php b/wp-includes/comment-template.php index f19d1a99da..ac843243e9 100644 --- a/wp-includes/comment-template.php +++ b/wp-includes/comment-template.php @@ -1229,7 +1229,7 @@ function wp_comment_form_unfiltered_html_nonce() { * 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. * - * @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 * @@ -1242,6 +1242,7 @@ function wp_comment_form_unfiltered_html_nonce() { * @global int $user_ID * @global string $user_identity * @global bool $overridden_cpage + * @global bool $withcomments * * @param string $file Optional. The file to load. Default '/comments.php'. * @param bool $separate_comments Optional. Whether to separate the comments by comment type. diff --git a/wp-includes/deprecated.php b/wp-includes/deprecated.php index c4d866ca22..4923ee46ea 100644 --- a/wp-includes/deprecated.php +++ b/wp-includes/deprecated.php @@ -2356,8 +2356,8 @@ function update_usermeta( $user_id, $meta_key, $meta_value ) { * @deprecated 3.1.0 Use get_users() * @see get_users() * - * @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 wpdb $wpdb WordPress database abstraction object. + * @global int $blog_id The Blog id of the blog for those that use more than one blog * * @param int $id Blog ID. * @return array List of users that are part of that Blog ID diff --git a/wp-includes/functions.php b/wp-includes/functions.php index d5edb2c917..c245af9928 100644 --- a/wp-includes/functions.php +++ b/wp-includes/functions.php @@ -675,8 +675,8 @@ function is_new_day() { * @since 2.3.0 * * @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 - * http_build_query() does. + * @link http://us2.php.net/manual/en/function.http-build-query.php for more on what + * http_build_query() does. * * @param array $data URL-encode key/value pairs. * @return string URL-encoded string. diff --git a/wp-includes/functions.wp-scripts.php b/wp-includes/functions.wp-scripts.php index a3ac7e60fc..c83a9d1d93 100644 --- a/wp-includes/functions.wp-scripts.php +++ b/wp-includes/functions.wp-scripts.php @@ -90,7 +90,8 @@ function wp_print_scripts( $handles = false ) { * * 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 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. * - * @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 * diff --git a/wp-includes/functions.wp-styles.php b/wp-includes/functions.wp-styles.php index 2036f4b951..5acea977fe 100644 --- a/wp-includes/functions.wp-styles.php +++ b/wp-includes/functions.wp-styles.php @@ -136,7 +136,8 @@ function wp_deregister_style( $handle ) { * * 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. * * @since 2.6.0 diff --git a/wp-includes/general-template.php b/wp-includes/general-template.php index 88b1a30881..9036de14bf 100644 --- a/wp-includes/general-template.php +++ b/wp-includes/general-template.php @@ -2736,7 +2736,7 @@ function wp_default_editor() { * containing TinyMCE: 'edit_page_form', 'edit_form_advanced' and 'dbx_post_sidebar'. * 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 * * @param string $content Initial content for the editor. diff --git a/wp-includes/query.php b/wp-includes/query.php index 9782eb4931..87d74ba242 100644 --- a/wp-includes/query.php +++ b/wp-includes/query.php @@ -1517,7 +1517,7 @@ class WP_Query { * @type string $meta_compare Comparison operator to test the 'meta_value'. * @type string $meta_key Custom field key. * @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 int $meta_value_num Custom field value number. * @type int $menu_order The menu order of the posts. diff --git a/wp-includes/update.php b/wp-includes/update.php index ed951fefbb..ec8cdbaa8a 100644 --- a/wp-includes/update.php +++ b/wp-includes/update.php @@ -339,7 +339,6 @@ function wp_update_plugins( $extra_stats = array() ) { * installing. * * @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. */ diff --git a/wp-includes/version.php b/wp-includes/version.php index b17950fff9..44707d7b6b 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @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.