aboutsummaryrefslogtreecommitdiff
path: root/engine/lib
diff options
context:
space:
mode:
authorcash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>2009-11-10 12:45:29 +0000
committercash <cash@36083f99-b078-4883-b0ff-0f9b5a30f544>2009-11-10 12:45:29 +0000
commit8813c21c7a7bf08ce8d80d8b6a8974ba9a030d24 (patch)
treee7ccd2316bf649b2521ec795eb63cfd3e1949eeb /engine/lib
parent3ae8de6ca798fb80b93bef3ec03e29c7ed43fbd2 (diff)
downloadelgg-8813c21c7a7bf08ce8d80d8b6a8974ba9a030d24.tar.gz
elgg-8813c21c7a7bf08ce8d80d8b6a8974ba9a030d24.tar.bz2
updated documentation of functions used in creating the topbar tools dropdown menu
git-svn-id: http://code.elgg.org/elgg/trunk@3660 36083f99-b078-4883-b0ff-0f9b5a30f544
Diffstat (limited to 'engine/lib')
-rw-r--r--engine/lib/elgglib.php8
1 files changed, 6 insertions, 2 deletions
diff --git a/engine/lib/elgglib.php b/engine/lib/elgglib.php
index f67220f57..856852729 100644
--- a/engine/lib/elgglib.php
+++ b/engine/lib/elgglib.php
@@ -1332,10 +1332,13 @@ function get_register($register_name) {
/**
* Adds an item to the menu register
+ * This is used in the core to create the tools dropdown menu
+ * You can obtain the menu array by calling get_register('menu')
*
- * @param string $menu_name The name of the top-level menu
+ * @param string $menu_name The name of the menu item
* @param string $menu_url The URL of the page
- * @param array $menu_children Optionally, an array of submenu items
+ * @param array $menu_children Optionally, an array of submenu items (not currently used)
+ * @param string $context (not used and will likely be deprecated)
* @return true|false Depending on success
*/
function add_menu($menu_name, $menu_url, $menu_children = array(), $context = "") {
@@ -1354,6 +1357,7 @@ function add_menu($menu_name, $menu_url, $menu_children = array(), $context = ""
/**
* Returns a menu item for use in the children section of add_menu()
+ * This is not currently used in the Elgg core
*
* @param string $menu_name The name of the menu item
* @param string $menu_url Its URL