From 38ff04eb58ecd2c549b398dce31259f46e837b7c Sat, 12 Nov 2011 01:28:36 +0100 From: Bram Goffings Date: Sat, 12 Nov 2011 01:28:23 +0100 Subject: [PATCH] shortcut module doc fixes diff --git a/core/modules/shortcut/shortcut-rtl.css b/core/modules/shortcut/shortcut-rtl.css index 5dec957..fc72c8d 100644 --- a/core/modules/shortcut/shortcut-rtl.css +++ b/core/modules/shortcut/shortcut-rtl.css @@ -1,3 +1,7 @@ +/** + * @file + * Shortcut rtl styling + */ div#toolbar a#edit-shortcuts { position: absolute; diff --git a/core/modules/shortcut/shortcut.admin.css b/core/modules/shortcut/shortcut.admin.css index 8ca03be..fc3a62a 100644 --- a/core/modules/shortcut/shortcut.admin.css +++ b/core/modules/shortcut/shortcut.admin.css @@ -1,4 +1,8 @@ - +/** + * @file + * Shortcut admin styling + */ + .shortcut-slot-hidden { display: none; } diff --git a/core/modules/shortcut/shortcut.admin.inc b/core/modules/shortcut/shortcut.admin.inc index 75c12b4..fc27bb7 100644 --- a/core/modules/shortcut/shortcut.admin.inc +++ b/core/modules/shortcut/shortcut.admin.inc @@ -18,7 +18,7 @@ } /** - * Form callback: builds the form for switching shortcut sets. + * Form callback: Builds the form for switching shortcut sets. * * @param $form * An associative array containing the structure of the form. @@ -164,7 +164,7 @@ } /** - * Menu page callback: builds the page for administering shortcut sets. + * Menu page callback: Builds the page for administering shortcut sets. */ function shortcut_set_admin() { $shortcut_sets = shortcut_sets(); @@ -191,7 +191,7 @@ } /** - * Form callback: builds the form for adding a shortcut set. + * Form callback: Builds the form for adding a shortcut set. * * @param $form * An associative array containing the structure of the form. @@ -248,7 +248,7 @@ } /** - * Form callback: builds the form for customizing shortcut sets. + * Form callback: Builds the form for customizing shortcut sets. * * @param $form * An associative array containing the structure of the form. @@ -400,7 +400,7 @@ } /** - * Form callback: builds the form for adding a new shortcut link. + * Form callback: Builds the form for adding a new shortcut link. * * @param $form * An associative array containing the structure of the form. @@ -427,7 +427,7 @@ } /** - * Form callback: builds the form for editing a shortcut link. + * Form callback: Builds the form for editing a shortcut link. * * @param $form * An associative array containing the structure of the form. @@ -454,7 +454,7 @@ } /** - * Helper function for building a form for adding or editing shortcut links. + * Helper function: Builds a form for adding or editing shortcut links. * * @param $shortcut_link * (optional) An array representing the shortcut link that will be edited. If @@ -582,7 +582,7 @@ } /** - * Form callback: builds the form for editing the shortcut set name. + * Form callback: Builds the form for editing the shortcut set name. * * @param $form * An associative array containing the structure of the form. @@ -645,7 +645,7 @@ } /** - * Form callback: builds the confirmation form for deleting a shortcut set. + * Form callback: Builds the confirmation form for deleting a shortcut set. * * @param $form * An associative array containing the structure of the form. @@ -750,7 +750,7 @@ } /** - * Menu page callback: creates a new link in the provided shortcut set. + * Menu page callback: Creates a new link in the provided shortcut set. * * After completion, redirects the user back to where they came from. * diff --git a/core/modules/shortcut/shortcut.admin.js b/core/modules/shortcut/shortcut.admin.js index 5e71e6f..3557eb8 100644 --- a/core/modules/shortcut/shortcut.admin.js +++ b/core/modules/shortcut/shortcut.admin.js @@ -1,3 +1,8 @@ +/** + * @file + * Shortcut jquery behaviours + */ + (function ($) { /** diff --git a/core/modules/shortcut/shortcut.api.php b/core/modules/shortcut/shortcut.api.php index 717a7c9..0022e0c 100644 --- a/core/modules/shortcut/shortcut.api.php +++ b/core/modules/shortcut/shortcut.api.php @@ -26,6 +26,7 @@ * * @param $account * The user account whose default shortcut set is being requested. + * * @return * The name of the shortcut set that this module recommends for that user, if * there is one. diff --git a/core/modules/shortcut/shortcut.css b/core/modules/shortcut/shortcut.css index 3afcb94..67ddaf7 100644 --- a/core/modules/shortcut/shortcut.css +++ b/core/modules/shortcut/shortcut.css @@ -1,3 +1,8 @@ +/** + * @file + * Shortcut styling + */ + div#toolbar a#edit-shortcuts { float: right; padding: 5px 10px 5px 5px; diff --git a/core/modules/shortcut/shortcut.module b/core/modules/shortcut/shortcut.module index f8ddcc2..e9bf46f 100644 --- a/core/modules/shortcut/shortcut.module +++ b/core/modules/shortcut/shortcut.module @@ -207,7 +207,7 @@ } /** - * Access callback for editing a shortcut set. + * Access callback: Edits a shortcut set. * * @param object $shortcut_set * (optional) The shortcut set to be edited. If not set, the current user's @@ -230,7 +230,7 @@ } /** - * Access callback for deleting a shortcut set. + * Access callback: Deletes a shortcut set. * * @param $shortcut_set * The shortcut set to be deleted. @@ -254,7 +254,7 @@ } /** - * Access callback for switching the shortcut set assigned to a user account. + * Access callback: Switches the shortcut set assigned to a user account. * * @param object $account * (optional) The user account whose shortcuts will be switched. If not set, @@ -288,7 +288,7 @@ } /** - * Access callback for editing a link in a shortcut set. + * Access callback: Edits a link in a shortcut set. */ function shortcut_link_access($menu_link) { // The link must belong to a shortcut set that the current user has access @@ -588,7 +588,7 @@ } /** - * Check to see if a shortcut set with the given title already exists. + * Checks if a shortcut set with the given title already exists. * * @param $title * Human-readable name of the shortcut set to check. @@ -605,6 +605,7 @@ * * @param $path * The path to the link. + * * @return * TRUE if the shortcut link is valid, FALSE otherwise. Valid links are ones * that correspond to actual paths on the site. @@ -627,6 +628,7 @@ * @param $shortcut_set * (optional) An object representing the set whose links will be displayed. * If not provided, the user's current set will be displayed. + * * @return * An array of shortcut links, in the format returned by the menu system. * @@ -707,7 +709,7 @@ } /** - * Pre-render function for adding shortcuts to the toolbar drawer. + * Pre-render function: Adds shortcuts to the toolbar drawer. */ function shortcut_toolbar_pre_render($toolbar) { $links = shortcut_renderable_links();