summaryrefslogtreecommitdiff
path: root/includes
diff options
context:
space:
mode:
authorwebchick <webchick@24967.no-reply.drupal.org>2011-10-16 02:07:57 -0700
committerwebchick <webchick@24967.no-reply.drupal.org>2011-10-16 02:07:57 -0700
commit19ac9357bbb419c3dac515888f43480a2c794d80 (patch)
treef1daff86d8c49cc5f7b9780022978247cee1cfde /includes
parent73da458f28642853847758ef79336a5cc6371b72 (diff)
downloadbrdo-19ac9357bbb419c3dac515888f43480a2c794d80.tar.gz
brdo-19ac9357bbb419c3dac515888f43480a2c794d80.tar.bz2
Issue #1258176 by sven.lauer: API doc for element_children() is only useful for people who already know what 'children' are.
Diffstat (limited to 'includes')
-rw-r--r--includes/common.inc7
1 files changed, 5 insertions, 2 deletions
diff --git a/includes/common.inc b/includes/common.inc
index bd7c6892b..3a3d27473 100644
--- a/includes/common.inc
+++ b/includes/common.inc
@@ -6135,10 +6135,13 @@ function element_child($key) {
}
/**
- * Return the children of an element, optionally sorted by weight.
+ * Identifies the children of an element array, optionally sorted by weight.
+ *
+ * The children of a element array are those key/value pairs whose key does
+ * not start with a '#'. See drupal_render() for details.
*
* @param $elements
- * The element to be sorted.
+ * The element array whose children are to be identified.
* @param $sort
* Boolean to indicate whether the children should be sorted by weight.
* @return