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
This commit is contained in:
Drew Jaynes 2014-11-18 18:47:22 +00:00
parent 5943966b69
commit 51e7e8e695
1 changed files with 4 additions and 3 deletions

View File

@ -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.