From 51e7e8e6956b4bf8dbd5ca16ef0a73d6abd1219c Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Tue, 18 Nov 2014 18:47:22 +0000 Subject: [PATCH] Clarify/correct inline documentation in wp-includes/l10n.php. * Add a missing `@return` description for `load_default_textdomain()` * Clarify the `@param` description for `$locale` with an inline `@see` tag * Ensure the correct parameter variable is used when documenting `$args` for `wp_dropdown_languages()` Props camdensegal. Fixes #30385. Built from https://develop.svn.wordpress.org/trunk@30380 git-svn-id: http://core.svn.wordpress.org/trunk@30377 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/l10n.php | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/wp-includes/l10n.php b/wp-includes/l10n.php index 7de619d15c..6c45a8581a 100644 --- a/wp-includes/l10n.php +++ b/wp-includes/l10n.php @@ -532,7 +532,8 @@ function unload_textdomain( $domain ) { * * @since 1.5.0 * - * @param string $locale Optional. Locale to load. Defaults to get_locale(). + * @param string $locale Optional. Locale to load. Default is the value of {@see get_locale()}. + * @return bool Whether the textdomain was loaded. */ function load_default_textdomain( $locale = null ) { if ( null === $locale ) { @@ -849,8 +850,8 @@ function wp_get_pomo_file_data( $po_file ) { * @see get_available_languages() * @see wp_get_available_translations() * - * @param string|array $query { - * Optional. Array of arguments. + * @param string|array $args { + * Optional. Array or string of arguments for outputting the language selector. * * @type string $id ID attribute of the select element. Default empty. * @type string $name Name attribute of the select element. Default empty.