summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorcatch2011-12-19 10:59:44 (GMT)
committercatch2011-12-19 10:59:44 (GMT)
commitaa44116fd9d247f72ab3745ea234d3577bde2bcd (patch)
treeff71ee94c5c797317d82ed7447f404b0c4d579a9
parent5fb188f2d03a1e99acff15e3a22e57305fd512c8 (diff)
Issue #1367014 by chris.leversuch: Clean up API docs for toolbar module.
-rw-r--r--core/modules/toolbar/toolbar.module29
1 files changed, 24 insertions, 5 deletions
diff --git a/core/modules/toolbar/toolbar.module b/core/modules/toolbar/toolbar.module
index d25ca2d..5151966 100644
--- a/core/modules/toolbar/toolbar.module
+++ b/core/modules/toolbar/toolbar.module
@@ -65,7 +65,11 @@ function toolbar_menu() {
}
/**
- * Menu callback; toggles the visibility of the toolbar drawer.
+ * Page callback: Toggles the visibility of the toolbar drawer.
+ *
+ * Path: toolbar/toggle
+ *
+ * @see toolbar_menu().
*/
function toolbar_toggle_page() {
global $base_path;
@@ -82,6 +86,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.
*
@@ -124,10 +129,12 @@ function toolbar_page_build(&$page) {
}
/**
- * Prerender function for the toolbar.
+ * Provides pre_render function for the toolbar.
*
* Since building the toolbar takes some time, it is done just prior to
* rendering to ensure that it is built only if it will be displayed.
+ *
+ * @see toolbar_page_build().
*/
function toolbar_pre_render($toolbar) {
$toolbar = array_merge($toolbar, toolbar_view());
@@ -175,7 +182,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;
@@ -273,7 +283,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();
@@ -290,10 +303,13 @@ function toolbar_get_menu_tree() {
}
/**
- * Generate a links array from a menu tree array.
+ * Generates an array of links 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();
@@ -331,6 +347,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.
*/