summaryrefslogtreecommitdiff
path: root/includes
diff options
context:
space:
mode:
authorAngie Byron <webchick@24967.no-reply.drupal.org>2010-08-05 07:56:50 +0000
committerAngie Byron <webchick@24967.no-reply.drupal.org>2010-08-05 07:56:50 +0000
commit769f1867555e922374a142a17bffe1217aa52d43 (patch)
tree241f44a7223bb2c7e8d95d4d3f55bf70d1fdcecd /includes
parent9874567891b396f572d1d958e586f11341519688 (diff)
downloadbrdo-769f1867555e922374a142a17bffe1217aa52d43.tar.gz
brdo-769f1867555e922374a142a17bffe1217aa52d43.tar.bz2
#851348 by mr.baileys: Fixed Fix doc: menu_tree() returns a renderable array, not rendered HTML.
Diffstat (limited to 'includes')
-rw-r--r--includes/menu.inc5
1 files changed, 3 insertions, 2 deletions
diff --git a/includes/menu.inc b/includes/menu.inc
index d79621f93..4f610f39d 100644
--- a/includes/menu.inc
+++ b/includes/menu.inc
@@ -865,7 +865,7 @@ function menu_get_object($type = 'node', $position = 1, $path = NULL) {
}
/**
- * Render a menu tree based on the current path.
+ * Renders a menu tree based on the current path.
*
* The tree is expanded based on the current path and dynamic paths are also
* changed according to the defined to_arg functions (for example the 'My
@@ -875,7 +875,8 @@ function menu_get_object($type = 'node', $position = 1, $path = NULL) {
* The name of the menu.
*
* @return
- * The rendered HTML of that menu on the current page.
+ * A structured array representing the specified menu on the current page, to
+ * be rendered by drupal_render().
*/
function menu_tree($menu_name) {
$menu_output = &drupal_static(__FUNCTION__, array());