From e0b8aebadaa90cfde251c86dda84dc575c56d3ea Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Wed, 10 Jun 2009 21:52:36 +0000
Subject: - Patch #359719 by joachim, brianV: documentation for
 theme_menu_item().

---
 includes/menu.inc | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'includes')

diff --git a/includes/menu.inc b/includes/menu.inc
index 9fee6e638..f162d2e3c 100644
--- a/includes/menu.inc
+++ b/includes/menu.inc
@@ -1266,7 +1266,26 @@ function theme_menu_tree($tree) {
 /**
  * Generate the HTML output for a menu item and submenu.
  *
+ * The menu item's LI element is given one of the following classes:
+ * - expanded: The menu item is showing its submenu.
+ * - collapsed: The menu item has a submenu which is not shown.
+ * - leaf: The menu item has no submenu. 
+ *
  * @ingroup themeable
+ *
+ * @param $link
+ *   The fully-formatted link for this menu item.
+ * @param $has_children
+ *   Boolean value indicating if this menu item has children.
+ * @param $menu
+ *   Contains a fully-formatted submenu, if one exists for this menu item.
+ *   Defaults to NULL.
+ * @param $in_active_trail
+ *   Boolean determining if the current page is below the menu item in the
+ *   menu system. Defaults to FALSE.
+ * @param $extra_class
+ *   Extra classes that should be added to the class of the list item.
+ *   Defaults to NULL.
  */
 function theme_menu_item($link, $has_children, $menu = '', $in_active_trail = FALSE, $extra_class = NULL) {
   $class = ($menu ? 'expanded' : ($has_children ? 'collapsed' : 'leaf'));
-- 
cgit v1.2.3