summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorwebchick2011-10-17 16:22:46 (GMT)
committerwebchick2011-10-17 16:22:46 (GMT)
commit8e255c67bc52634ce8f445be1a81fc84d0a8e722 (patch)
tree645cf233037cb2a804dd82546f60d7e853d773f7
parentbf36c6cdf1cf921b0d517226dcf0d79ae1b861a7 (diff)
Issue #1234848 by mr.baileys, xjm: Fixed language_list() doc is missing return value.
-rw-r--r--includes/bootstrap.inc13
1 files changed, 11 insertions, 2 deletions
diff --git a/includes/bootstrap.inc b/includes/bootstrap.inc
index 9505870..a7257c7 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__);