diff options
| author | webchick <webchick@24967.no-reply.drupal.org> | 2012-01-11 23:18:00 -0500 |
|---|---|---|
| committer | webchick <webchick@24967.no-reply.drupal.org> | 2012-01-11 23:18:00 -0500 |
| commit | b9fb497483b375aaa2dca080754eb108cf4c1077 (patch) | |
| tree | d448f0038b8b26271aaf78456adc6d41cbb317f5 | |
| parent | 94ab1477811151755d46ca8b0c686891e0673276 (diff) | |
| download | brdo-b9fb497483b375aaa2dca080754eb108cf4c1077.tar.gz brdo-b9fb497483b375aaa2dca080754eb108cf4c1077.tar.bz2 | |
Issue #1367014 by chris.leversuch: Clean up API docs for toolbar module.
| -rw-r--r-- | modules/toolbar/toolbar.module | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/modules/toolbar/toolbar.module b/modules/toolbar/toolbar.module index 61ae648ad..de2d2619b 100644 --- a/modules/toolbar/toolbar.module +++ b/modules/toolbar/toolbar.module @@ -82,6 +82,7 @@ function toolbar_toggle_page() { * An associative array containing: * - collapsed: A boolean value representing the toolbar drawer's visibility. * - attributes: An associative array of HTML attributes. + * * @return * An HTML string representing the element for toggling. * @@ -175,7 +176,10 @@ function toolbar_system_info_alter(&$info, $file, $type) { } /** - * Build the admin menu as a structured array ready for drupal_render(). + * Builds the admin menu as a structured array ready for drupal_render(). + * + * @return + * Array of links and settings relating to the admin menu. */ function toolbar_view() { global $user; @@ -272,7 +276,10 @@ function toolbar_view() { } /** - * Get only the top level items below the 'admin' path. + * Gets only the top level items below the 'admin' path. + * + * @return + * An array containing a menu tree of top level items below the 'admin' path. */ function toolbar_get_menu_tree() { $tree = array(); @@ -289,10 +296,13 @@ function toolbar_get_menu_tree() { } /** - * Generate a links array from a menu tree array. + * Generates a links array from a menu tree array. * * Based on menu_navigation_links(). Adds path based IDs and icon placeholders * to the links. + * + * @return + * An array of links as defined above. */ function toolbar_menu_navigation_links($tree) { $links = array(); @@ -330,6 +340,9 @@ function toolbar_menu_navigation_links($tree) { * Useful when using a menu generated by menu_tree_all_data() which does * not set the 'in_active_trail' flag on items. * + * @return + * TRUE when path is in the active trail, FALSE if not. + * * @todo * Look at migrating to a menu system level function. */ |