From fe89f7620fe4e0e3e7c1ae180bdcb410ad3a9d6d Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Fri, 18 Dec 2015 23:37:58 +0000 Subject: [PATCH] Docs: Add missing parameter and return descriptions to the DocBlocks for `_wp_object_name_sort_cb()` and `_wp_object_count_sort_cb()`, both `uasort()` callbacks. See #32246. git-svn-id: https://develop.svn.wordpress.org/trunk@36013 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/category-template.php | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/src/wp-includes/category-template.php b/src/wp-includes/category-template.php index e452ccda25..b989ed526c 100644 --- a/src/wp-includes/category-template.php +++ b/src/wp-includes/category-template.php @@ -947,22 +947,33 @@ function wp_generate_tag_cloud( $tags, $args = '' ) { } /** - * Callback for comparing objects based on name + * Serves as a callback for comparing objects based on name. + * + * Used with `uasort()`. * * @since 3.1.0 * @access private - * @return int + * + * @param object $a The first object to compare. + * @param object $b The second object to compare. + * @return int Negative number if `$a->name` is less than `$b->name`, zero if they are equal, + * or greater than zero if `$a->name` is greater than `$b->name`. */ function _wp_object_name_sort_cb( $a, $b ) { return strnatcasecmp( $a->name, $b->name ); } /** - * Callback for comparing objects based on count + * Serves as a callback for comparing objects based on count. + * + * Used with `uasort()`. * * @since 3.1.0 * @access private - * @return bool + * + * @param object $a The first object to compare. + * @param object $b The second object to compare. + * @return bool Whether the count value for `$a` is greater than the count value for `$b`. */ function _wp_object_count_sort_cb( $a, $b ) { return ( $a->count > $b->count );