diff --git a/includes/bootstrap.inc b/includes/bootstrap.inc index 950587071325ec3bdff8b1cd0e1b1f83a297b339..a7257c7c450d5835b9dcba0af938ac5a4c7ebfdf 100644 --- a/includes/bootstrap.inc +++ b/includes/bootstrap.inc @@ -2580,9 +2580,18 @@ function language_types() { } /** - * Get a list of languages set up indexed by the specified key + * Returns a list of installed languages, indexed by the specified key. * - * @param $field The field to index the list with. + * @param $field + * (optional) The field to index the list with. + * + * @return + * An associative array, keyed on the values of $field. + * - If $field is 'weight' or 'enabled', the array is nested, with the outer + * array's values each being associative arrays with language codes as + * keys and language objects as values. + * - For all other values of $field, the array is only one level deep, and + * the array's values are language objects. */ function language_list($field = 'language') { $languages = &drupal_static(__FUNCTION__);