From c8537e7cede0a2cba88768156fc2318b0fa747f2 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Mon, 5 Oct 2015 02:28:33 +0000 Subject: [PATCH] Docs: Add missing summaries for three deprecated admin functions: `dropdown_categories()`, `dropdown_link_categories()`, and `wp_dropdown_cats()`. See #32246. git-svn-id: https://develop.svn.wordpress.org/trunk@34821 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/deprecated.php | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/src/wp-admin/includes/deprecated.php b/src/wp-admin/includes/deprecated.php index 7e37a3b7b6..1ddcef978f 100644 --- a/src/wp-admin/includes/deprecated.php +++ b/src/wp-admin/includes/deprecated.php @@ -69,15 +69,15 @@ function get_udims( $width, $height ) { } /** - * {@internal Missing Short Description}} + * Legacy function used to generate the categories checklist control. * * @since 0.71 * @deprecated 2.6.0 Use wp_category_checklist() * @see wp_category_checklist() * - * @param int $default - * @param int $parent - * @param array $popular_ids + * @param int $default Unused. + * @param int $parent Unused. + * @param array $popular_ids Unused. */ function dropdown_categories( $default = 0, $parent = 0, $popular_ids = array() ) { _deprecated_function( __FUNCTION__, '2.6', 'wp_category_checklist()' ); @@ -86,13 +86,13 @@ function dropdown_categories( $default = 0, $parent = 0, $popular_ids = array() } /** - * {@internal Missing Short Description}} + * Legacy function used to generate a link categories checklist control. * * @since 2.1.0 * @deprecated 2.6.0 Use wp_link_category_checklist() * @see wp_link_category_checklist() * - * @param int $default + * @param int $default Unused. */ function dropdown_link_categories( $default = 0 ) { _deprecated_function( __FUNCTION__, '2.6', 'wp_link_category_checklist()' ); @@ -117,18 +117,18 @@ function get_real_file_to_edit( $file ) { } /** - * {@internal Missing Short Description}} + * Legacy function used for generating a categories drop-down control. * * @since 1.2.0 * @deprecated 3.0.0 Use wp_dropdown_categories() * @see wp_dropdown_categories() * - * @param int $currentcat - * @param int $currentparent - * @param int $parent - * @param int $level - * @param array $categories - * @return bool|null + * @param int $currentcat Optional. ID of the current category. Default 0. + * @param int $currentparent Optional. Current parent category ID. Default 0. + * @param int $parent Optional. Parent ID to retrieve categories for. Default 0. + * @param int $level Optional. Number of levels deep to display. Default 0. + * @param array $categories Optional. Categories to include in the control. Default 0. + * @return bool|null False if no categories were found. */ function wp_dropdown_cats( $currentcat = 0, $currentparent = 0, $parent = 0, $level = 0, $categories = 0 ) { _deprecated_function( __FUNCTION__, '3.0', 'wp_dropdown_categories()' );