Changeset 30380

Timestamp:

11/18/2014 06:46:11 PM (10 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-includes/l10n.php (modified) (2 diffs)

trunk/src/wp-includes/l10n.php

@@ -533 +533 @@
  * @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 ) {
@@ -850 +851 @@
  * @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.