summaryrefslogtreecommitdiff
path: root/includes/common.inc
diff options
context:
space:
mode:
authorJennifer Hodgdon <yahgrp@poplarware.com>2014-01-23 11:33:09 -0800
committerJennifer Hodgdon <yahgrp@poplarware.com>2014-01-23 11:33:09 -0800
commit7f3e67040fc154072564217cce0cd8c5efcaefbc (patch)
treea57099a403acf4c4d48b9ba7cddfb8b3031361a7 /includes/common.inc
parenta2dee490c4c1196f429edef97ae94077a0f9749d (diff)
downloadbrdo-7f3e67040fc154072564217cce0cd8c5efcaefbc.tar.gz
brdo-7f3e67040fc154072564217cce0cd8c5efcaefbc.tar.bz2
Issue #2164597 by longwave, StephaneQ, emok: Fix up docs for drupal_render_children()
Diffstat (limited to 'includes/common.inc')
-rw-r--r--includes/common.inc16
1 files changed, 9 insertions, 7 deletions
diff --git a/includes/common.inc b/includes/common.inc
index 3b4bf580c..40a7919e0 100644
--- a/includes/common.inc
+++ b/includes/common.inc
@@ -5946,14 +5946,16 @@ function drupal_render(&$elements) {
/**
* Renders children of an element and concatenates them.
*
- * This renders all children of an element using drupal_render() and then
- * joins them together into a single string.
- *
- * @param $element
+ * @param array $element
* The structured array whose children shall be rendered.
- * @param $children_keys
- * If the keys of the element's children are already known, they can be passed
- * in to save another run of element_children().
+ * @param array $children_keys
+ * (optional) If the keys of the element's children are already known, they
+ * can be passed in to save another run of element_children().
+ *
+ * @return string
+ * The rendered HTML of all children of the element.
+
+ * @see drupal_render()
*/
function drupal_render_children(&$element, $children_keys = NULL) {
if ($children_keys === NULL) {