diff --git a/core/modules/overlay/overlay-child-rtl.css b/core/modules/overlay/overlay-child-rtl.css index 2bc5548..185ab86 100644 --- a/core/modules/overlay/overlay-child-rtl.css +++ b/core/modules/overlay/overlay-child-rtl.css @@ -1,4 +1,9 @@ +/** + * @file + * RTL styling for Overlay child pages. + */ + html { direction: rtl; } diff --git a/core/modules/overlay/overlay-child.css b/core/modules/overlay/overlay-child.css index f760c26..b7603db 100644 --- a/core/modules/overlay/overlay-child.css +++ b/core/modules/overlay/overlay-child.css @@ -1,4 +1,9 @@ +/** + * @file + * Basic styling for the Overlay child pages. + */ + .js { background: transparent !important; overflow-y: scroll; diff --git a/core/modules/overlay/overlay-child.js b/core/modules/overlay/overlay-child.js index 29a9790..efec27b 100644 --- a/core/modules/overlay/overlay-child.js +++ b/core/modules/overlay/overlay-child.js @@ -1,3 +1,8 @@ +/** + * @file + * Attaches the behaviors for the Overlay child pages. + */ + (function ($) { "use strict"; diff --git a/core/modules/overlay/overlay-parent.css b/core/modules/overlay/overlay-parent.css index dad6d55..9459a7a 100644 --- a/core/modules/overlay/overlay-parent.css +++ b/core/modules/overlay/overlay-parent.css @@ -1,4 +1,9 @@ +/** + * @file + * Basic styling for the Overlay module. + */ + html.overlay-open, html.overlay-open body { height: 100%; diff --git a/core/modules/overlay/overlay-parent.js b/core/modules/overlay/overlay-parent.js index 6537cb6..4078e83 100644 --- a/core/modules/overlay/overlay-parent.js +++ b/core/modules/overlay/overlay-parent.js @@ -1,3 +1,8 @@ +/** + * @file + * Attaches the behaviors for the Overlay parent pages. + */ + (function ($) { "use strict"; diff --git a/core/modules/overlay/overlay.install b/core/modules/overlay/overlay.install index 2fa7c84..5fc2936 100644 --- a/core/modules/overlay/overlay.install +++ b/core/modules/overlay/overlay.install @@ -2,7 +2,7 @@ /** * @file - * Install, update and uninstall functions for the overlay module. + * Install, update, and uninstall functions for the Overlay module. */ /** diff --git a/core/modules/overlay/overlay.module b/core/modules/overlay/overlay.module index 7fb7e0b..8133071 100644 --- a/core/modules/overlay/overlay.module +++ b/core/modules/overlay/overlay.module @@ -322,7 +322,7 @@ function overlay_user_dismiss_message_access() { } /** - * Menu callback; dismisses the overlay accessibility message for this user. + * Menu callback; Dismisses the overlay accessibility message for this user. * * @see overlay_user_dismiss_message_access() * @see overlay_menu() @@ -352,10 +352,12 @@ function overlay_user_dismiss_message() { * If the current user can access the overlay and has not previously indicated * that this message should be dismissed, this function returns a message * containing a link to disable the overlay. Nothing is returned for anonymous - * users, because the links control per-user settings. Therefore, because some - * screen readers are unable to properly read overlay contents, site builders - * are discouraged from granting the "access overlay" permission to the - * anonymous role. See http://drupal.org/node/890284. + * users, because the links control per-user settings. Because some screen + * readers are unable to properly read overlay contents, site builders are + * discouraged from granting the "access overlay" permission to the anonymous + * role. + * + * @see http://drupal.org/node/890284 */ function overlay_disable_message() { global $user; @@ -410,7 +412,12 @@ function overlay_disable_message() { /** * Returns the HTML for the message about how to disable the overlay. * - * @see overlay_disable_message() + * @param $variables + * An associative array containing: + * - profile_link: The link to this user's account + * - dismiss_message_link: Link to dismiss the overlay + * + * @ingroup themeable */ function theme_overlay_disable_message($variables) { $element = $variables['element']; @@ -496,9 +503,10 @@ function overlay_preprocess_maintenance_page(&$variables) { } /** - * Preprocesses template variables for overlay.tpl.php + * Implements hook_preprocess_HOOK() for overlay.tpl.php * - * @see overlay.tpl.php + * If the current page request is inside the overlay, add appropriate classes + * to the element, and simplify the page title. */ function template_preprocess_overlay(&$variables) { $variables['tabs'] = menu_primary_local_tasks(); @@ -512,6 +520,8 @@ function template_preprocess_overlay(&$variables) { * * @see template_preprocess_overlay() * @see overlay.tpl.php + * + * @todo - Update this to current standards. */ function template_process_overlay(&$variables) { // Place the rendered HTML for the page body into a top level variable. @@ -524,6 +534,8 @@ function template_process_overlay(&$variables) { * Hide tabs inside the overlay. * * @see overlay_get_mode() + * + * @todo - Update this to current standards. */ function overlay_preprocess_page(&$variables) { if (overlay_get_mode() == 'child') { @@ -577,6 +589,8 @@ function overlay_page_delivery_callback_alter(&$callback) { * * This function is used to print out a bare minimum empty page which still has * the scripts and styles necessary in order to trigger the overlay to close. + * + * @todo - Update this to current standards. */ function overlay_deliver_empty_page() { $empty_page = '' . drupal_get_css() . drupal_get_js() . ''; @@ -585,7 +599,7 @@ function overlay_deliver_empty_page() { } /** - * Get the current overlay mode. + * Gets the current overlay mode. * * @see overlay_set_mode() */ @@ -624,6 +638,8 @@ function overlay_get_mode() { * * @ingroup overlay_api * @see overlay_init() + * + * @todo - Update this to current standards. */ function overlay_set_mode($mode = NULL) { global $base_path; @@ -778,7 +794,7 @@ function overlay_supplemental_regions() { } /** - * Helper function for returning a list of page regions related to the overlay. + * Returns a list of page regions related to the overlay. * * @param $type * The type of regions to return. This can either be 'overlay_regions' or diff --git a/core/modules/overlay/overlay.tpl.php b/core/modules/overlay/overlay.tpl.php index 54b10af..6fb97ed 100644 --- a/core/modules/overlay/overlay.tpl.php +++ b/core/modules/overlay/overlay.tpl.php @@ -11,8 +11,8 @@ * (e.g., the view and edit tabs when displaying a node). * * Helper variables: - * - $classes_array: Array of html class attribute values. It is flattened - * into a string within the variable $classes. + * - $classes_array: Array of html class attribute values. It is flattened into + * a string within the variable $classes. * * @see template_preprocess() * @see template_preprocess_overlay()