diff --git a/includes/image.inc b/includes/image.inc index 8dc36b9..ac7a1df 100644 --- a/includes/image.inc +++ b/includes/image.inc @@ -28,8 +28,8 @@ * toolkit must then be enabled using the admin/config/media/image-toolkit * form. * - * Only one toolkit may be selected at a time. If a module author wishes to call - * a specific toolkit they can check that it is installed by calling + * Only one toolkit may be selected at a time. If a module author wishes to + * call a specific toolkit they can check that it is installed by calling * image_get_available_toolkits(), and then calling its functions directly. */ @@ -146,9 +146,9 @@ function image_get_info($filepath, $toolkit = FALSE) { /** * Scales an image to the exact width and height given. * - * This function achieves the target aspect ratio by cropping the original image - * equally on both sides, or equally on the top and bottom. This function is - * useful to create uniform sized avatars from larger images. + * This function achieves the target aspect ratio by cropping the original + * image equally on both sides, or equally on the top and bottom. This + * function is useful to create uniform sized avatars from larger images. * * The resulting image always has the exact target dimensions. * diff --git a/includes/install.inc b/includes/install.inc index 7dbd805..5da0b64 100644 --- a/includes/install.inc +++ b/includes/install.inc @@ -71,7 +71,7 @@ define('FILE_NOT_WRITABLE', 64); define('FILE_NOT_EXECUTABLE', 128); /** - * Initialize the update system by loading all installed module's .install files. + * Loads all installed module's .install files to initialize the update system. */ function drupal_load_updates() { foreach (drupal_get_installed_schema_version(NULL, FALSE, TRUE) as $module => $schema_version) { @@ -86,9 +86,10 @@ function drupal_load_updates() { * * @param $module * A module name. + * * @return - * If the module has updates, an array of available updates sorted by version. - * Otherwise, FALSE. + * If the module has updates, an array of available updates sorted by + * version. Otherwise, FALSE. */ function drupal_get_schema_versions($module) { $updates = &drupal_static(__FUNCTION__, NULL); @@ -134,6 +135,7 @@ function drupal_get_schema_versions($module) { * @param $array * Set to TRUE if you want to get information about all modules in the * system. + * * @return * The currently installed schema version, or SCHEMA_UNINSTALLED if the * module is not installed. @@ -209,6 +211,7 @@ function drupal_install_profile_distribution_name() { * @param $file * The name of the file calling this function so we can strip it out of * the URI when generating the base_url. + * * @return * The auto-detected $base_url that should be configured in settings.php */ @@ -288,8 +291,9 @@ abstract class DatabaseTasks { * * @var array * - * Each value of the tasks array is an associative array defining the function - * to call (optional) and any arguments to be passed to the function. + * Each value of the tasks array is an associative array defining the + * function to call (optional) and any arguments to be passed to the + * function. */ protected $tasks = array( array( @@ -438,7 +442,7 @@ abstract class DatabaseTasks { } /** - * Run SQL tests to ensure the database can execute commands with the current user. + * Tests to ensure the database can execute commands with the current user. */ protected function runTestQuery($query, $pass, $fail, $fatal = FALSE) { try { @@ -658,6 +662,7 @@ function drupal_rewrite_settings($settings = array()) { * * @param $install_state * An array of information about the current installation state. + * * @return * The list of modules to install. */ @@ -808,6 +813,7 @@ function drupal_uninstall_modules($module_list = array(), $uninstall_dependents * An optional bitmask created from various FILE_* constants. * @param $type * The type of file. Can be file (default), dir, or link. + * * @return * TRUE on success or FALSE on failure. A message is set for the latter. */ @@ -887,6 +893,7 @@ function drupal_verify_install_file($file, $mask = NULL, $type = 'file') { * The permissions of the directory to create. * @param $message * (optional) Whether to output messages. Defaults to TRUE. + * * @return * TRUE/FALSE whether or not the directory was successfully created. */ @@ -935,6 +942,7 @@ function drupal_install_mkdir($file, $mask, $message = TRUE) { * The desired permissions for the file. * @param $message * (optional) Whether to output messages. Defaults to TRUE. + * * @return * TRUE/FALSE whether or not we were able to fix the file's permissions. */ @@ -1142,6 +1150,7 @@ function st($string, array $args = array(), array $options = array()) { * * @param $profile * Name of install profile to check. + * * @return * Array of the install profile's requirements. */ @@ -1174,6 +1183,7 @@ function drupal_check_profile($profile) { * @param $requirements * An array of requirements, in the same format as is returned by * hook_requirements(). + * * @return * The highest severity in the array. */ @@ -1192,6 +1202,7 @@ function drupal_requirements_severity(&$requirements) { * * @param $module * Machine name of module to check. + * * @return * TRUE/FALSE depending on the requirements are in place. */ @@ -1224,7 +1235,8 @@ function drupal_check_module($module) { * a normal Drupal module .info file. For example: * - name: The real name of the install profile for display purposes. * - description: A brief description of the profile. - * - dependencies: An array of shortnames of other modules this install profile requires. + * - dependencies: An array of shortnames of other modules this install + * profile requires. * * Additional, less commonly-used information that can appear in a profile.info * file but not in a normal Drupal module .info file includes: diff --git a/includes/language.inc b/includes/language.inc index c729ec2..cf517ca 100644 --- a/includes/language.inc +++ b/includes/language.inc @@ -37,11 +37,12 @@ function language_types_info() { * language type itself. * * @param $stored - * Optional. By default retrieves values from the 'language_types' variable to - * avoid unnecessary hook invocations. - * If set to FALSE retrieves values from the actual language type definitions. - * This allows to react to alterations performed on the definitions by modules - * installed after the 'language_types' variable is set. + * Optional. By default retrieves values from the 'language_types' variable + * to avoid unnecessary hook invocations. + * If set to FALSE retrieves values from the actual language type + * definitions. This allows to react to alterations performed on the + * definitions by modules installed after the 'language_types' variable is + * set. * * @return * An array of language type names. @@ -155,8 +156,7 @@ function language_negotiation_get($type, $provider_id = NULL) { } /** - * Check if the given language provider is enabled for any configurable language - * type. + * Checks if the given provider is enabled for any configurable language type. * * @param $provider_id * The language provider ID. @@ -212,7 +212,7 @@ function language_negotiation_get_switch_links($type, $path) { } /** - * Updates language configuration to remove any language provider that is no longer defined. + * Removes providers that are not defined from the language configuration. */ function language_negotiation_purge() { // Ensure that we are getting the defined language negotiation information. An diff --git a/includes/locale.inc b/includes/locale.inc index 906a36e..38210ae 100644 --- a/includes/locale.inc +++ b/includes/locale.inc @@ -274,19 +274,19 @@ function locale_language_from_url($languages) { * The language negotiation process has a fallback chain that ends with the * default language provider. Each built-in language type has a separate * initialization: - * - Interface language, which is the only configurable one, always gets a valid - * value. If no request-specific language is detected, the default language - * will be used. + * - Interface language, which is the only configurable one, always gets a + * valid value. If no request-specific language is detected, the default + * language will be used. * - Content language merely inherits the interface language by default. - * - URL language is detected from the requested URL and will be used to rewrite - * URLs appearing in the page being rendered. If no language can be detected, - * there are two possibilities: - * - If the default language has no configured path prefix or domain, then the - * default language is used. This guarantees that (missing) URL prefixes are - * preserved when navigating through the site. + * - URL language is detected from the requested URL and will be used to + * rewrite URLs appearing in the page being rendered. If no language can be + * detected, there are two possibilities: + * - If the default language has no configured path prefix or domain, then + * the default language is used. This guarantees that (missing) URL + * prefixes are preserved when navigating through the site. * - If the default language has a configured path prefix or domain, a - * requested URL having an empty prefix or domain is an anomaly that must be - * fixed. This is done by introducing a prefix or domain in the rendered + * requested URL having an empty prefix or domain is an anomaly that must + * be fixed. This is done by introducing a prefix or domain in the rendered * page matching the detected interface language. * * @param $languages @@ -475,7 +475,8 @@ function locale_string_is_safe($string) { * API function to add or update a language. * * @param $language - * Language object with properties corresponding to 'languages' table columns. + * Language object with properties corresponding to 'languages' table + * columns. */ function locale_language_save($language) { $language->is_new = !(bool) db_query_range('SELECT 1 FROM {languages} WHERE language = :language', 0, 1, array(':language' => $language->language))->fetchField(); @@ -802,7 +803,7 @@ function _locale_rebuild_js($langcode = NULL) { */ /** - * Prepares the language code list for a select form item with only the unsupported ones + * Prepares a list of unspported language codes for a select form item. */ function _locale_prepare_predefined_list() { include_once DRUPAL_ROOT . '/includes/standard.inc'; diff --git a/includes/mail.inc b/includes/mail.inc index 7272df9..734e4ef 100644 --- a/includes/mail.inc +++ b/includes/mail.inc @@ -67,8 +67,8 @@ define('MAIL_LINE_ENDINGS', isset($_SERVER['WINDIR']) || strpos($_SERVER['SERVER * * @param $module * A module name to invoke hook_mail() on. The {$module}_mail() hook will be - * called to complete the $message structure which will already contain common - * defaults. + * called to complete the $message structure which will already contain + * common defaults. * @param $key * A key to identify the e-mail sent. The final e-mail id for e-mail altering * will be {$module}_{$key}. @@ -93,8 +93,9 @@ define('MAIL_LINE_ENDINGS', isset($_SERVER['WINDIR']) || strpos($_SERVER['SERVER * The $message array structure containing all details of the * message. If already sent ($send = TRUE), then the 'result' element * will contain the success indicator of the e-mail, failure being already - * written to the watchdog. (Success means nothing more than the message being - * accepted at php-level, which still doesn't guarantee it to be delivered.) + * written to the watchdog. (Success means nothing more than the message + * being accepted at php-level, which still doesn't guarantee it to be + * delivered.) */ function drupal_mail($module, $key, $to, $language, $params = array(), $from = NULL, $send = TRUE) { $default_from = variable_get('site_mail', ini_get('sendmail_from')); @@ -168,25 +169,26 @@ function drupal_mail($module, $key, $to, $language, $params = array(), $from = N * * An implementation needs to implement the following methods: * - format: Allows to preprocess, format, and postprocess a mail - * message before it is passed to the sending system. By default, all messages - * may contain HTML and are converted to plain-text by the DefaultMailSystem - * implementation. For example, an alternative implementation could override - * the default implementation and additionally sanitize the HTML for usage in - * a MIME-encoded e-mail, but still invoking the DefaultMailSystem - * implementation to generate an alternate plain-text version for sending. + * message before it is passed to the sending system. By default, all + * messages may contain HTML and are converted to plain-text by the + * DefaultMailSystem implementation. For example, an alternative + * implementation could override the default implementation and + * additionally sanitize the HTML for usage in a MIME-encoded e-mail, but + * still invoking the DefaultMailSystem implementation to generate an + * alternate plain-text version for sending. * - mail: Sends a message through a custom mail sending engine. * By default, all messages are sent via PHP's mail() function by the * DefaultMailSystem implementation. * * The selection of a particular implementation is controlled via the variable * 'mail_system', which is a keyed array. The default implementation - * is the class whose name is the value of 'default-system' key. A more specific - * match first to key and then to module will be used in preference to the - * default. To specificy a different class for all mail sent by one module, set - * the class name as the value for the key corresponding to the module name. To - * specificy a class for a particular message sent by one module, set the class - * name as the value for the array key that is the message id, which is - * "${module}_${key}". + * is the class whose name is the value of 'default-system' key. A more + * specific match first to key and then to module will be used in preference + * to the default. To specificy a different class for all mail sent by one + * module, set the class name as the value for the key corresponding to the + * module name. To specificy a class for a particular message sent by one + * module, set the class name as the value for the array key that is the + * message id, which is "${module}_${key}". * * For example to debug all mail sent by the user module by logging it to a * file, you might set the variable as something like: @@ -274,10 +276,11 @@ interface MailSystemInterface { * * @param $message * Message array with at least the following elements: - * - id: A unique identifier of the e-mail type. Examples: 'contact_user_copy', - * 'user_password_reset'. + * - id: A unique identifier of the e-mail type. Examples: + * 'contact_user_copy', 'user_password_reset'. * - to: The mail address or addresses where the message will be sent to. - * The formatting of this string must comply with RFC 2822. Some examples: + * The formatting of this string must comply with RFC 2822. Some + * examples: * - user@example.com * - user@example.com, anotheruser@example.com * - User @@ -292,7 +295,8 @@ interface MailSystemInterface { * and Bcc headers and sends the mail to addresses in these headers too. * * @return - * TRUE if the mail was successfully accepted for delivery, otherwise FALSE. + * TRUE if the mail was successfully accepted for delivery, otherwise + * FALSE. */ public function mail(array $message); } @@ -562,7 +566,8 @@ function _drupal_html_to_mail_urls($match = NULL, $reset = FALSE) { /** * Helper function for drupal_wrap_mail() and drupal_html_to_text(). * - * Replace all non-quotation markers from a given piece of indentation with spaces. + * Replace all non-quotation markers from a given piece of indentation with + * spaces. */ function _drupal_html_to_text_clean($indent) { return preg_replace('/[^>]/', ' ', $indent); diff --git a/includes/menu.inc b/includes/menu.inc index f23eb0d..4bff9f5 100644 --- a/includes/menu.inc +++ b/includes/menu.inc @@ -15,8 +15,8 @@ * passed from the browser. For this reason, a good understanding of the * menu system is fundamental to the creation of complex modules. As a note, * this is related to, but separate from menu.module, which allows menus - * (which in this context are hierarchical lists of links) to be customized from - * the Drupal administrative interface. + * (which in this context are hierarchical lists of links) to be customized + * from the Drupal administrative interface. * * Drupal's menu system follows a simple hierarchy defined by paths. * Implementations of hook_menu() define menu items and assign them to @@ -129,8 +129,8 @@ define('MENU_IS_LOCAL_ACTION', 0x0100); * @{ * Definitions for various menu item types. * - * Menu item definitions provide one of these constants, which are shortcuts for - * combinations of @link menu_flags Menu flags @endlink. + * Menu item definitions provide one of these constants, which are shortcuts + * for combinations of @link menu_flags Menu flags @endlink. */ /** @@ -154,9 +154,9 @@ define('MENU_CALLBACK', 0x0000); * Menu type -- A normal menu item, hidden until enabled by an administrator. * * Modules may "suggest" menu items that the administrator may enable. They act - * just as callbacks do until enabled, at which time they act like normal items. - * Note for the value: 0x0010 was a flag which is no longer used, but this way - * the values of MENU_CALLBACK and MENU_SUGGESTED_ITEM are separate. + * just as callbacks do until enabled, at which time they act like normal + * items. Note for the value: 0x0010 was a flag which is no longer used, but + * this way the values of MENU_CALLBACK and MENU_SUGGESTED_ITEM are separate. */ define('MENU_SUGGESTED_ITEM', MENU_VISIBLE_IN_BREADCRUMB | 0x0010); @@ -172,8 +172,8 @@ define('MENU_LOCAL_TASK', MENU_IS_LOCAL_TASK | MENU_VISIBLE_IN_BREADCRUMB); /** * Menu type -- The "default" local task, which is initially active. * - * Every set of local tasks should provide one "default" task, that links to the - * same path as its parent when clicked. + * Every set of local tasks should provide one "default" task, that links to + * the same path as its parent when clicked. */ define('MENU_DEFAULT_LOCAL_TASK', MENU_IS_LOCAL_TASK | MENU_LINKS_TO_PARENT | MENU_VISIBLE_IN_BREADCRUMB); @@ -397,9 +397,9 @@ function menu_unserialize($data, $map) { * The path. * @param $router_item * The router item. Usually you take a router entry from menu_get_item and - * set it back either modified or to a different path. This lets you modify the - * navigation block, the page title, the breadcrumb and the page help in one - * call. + * set it back either modified or to a different path. This lets you modify + * the navigation block, the page title, the breadcrumb and the page help + * in one call. */ function menu_set_item($path, $router_item) { menu_get_item($path, $router_item); @@ -480,8 +480,8 @@ function menu_get_item($path = NULL, $router_item = NULL) { * the current path is used. * @param $deliver * (optional) A boolean to indicate whether the content should be sent to the - * browser using the appropriate delivery callback (TRUE) or whether to return - * the result to the caller (FALSE). + * browser using the appropriate delivery callback (TRUE) or whether to + * return the result to the caller (FALSE). */ function menu_execute_active_handler($path = NULL, $deliver = TRUE) { // Check if site is offline. @@ -631,6 +631,14 @@ function _menu_check_access(&$item, $map) { * strings in the database, yet display of them in the language required * by the current user. * + * $item['title'] is localized according to $item['title_callback']. + * If an item's callback is check_plain(), $item['options']['html'] becomes + * TRUE. + * + * $item['description'] is translated using t(). When doing link translation + * and the $item['options']['attributes']['title'] (link title attribute) + * matches the description, it is translated as well. + * * @param $item * A menu router item or a menu link item. * @param $map @@ -640,15 +648,6 @@ function _menu_check_access(&$item, $map) { * @param $link_translate * TRUE if we are translating a menu link item; FALSE if we are * translating a menu router item. - * - * @return - * No return value. - * $item['title'] is localized according to $item['title_callback']. - * If an item's callback is check_plain(), $item['options']['html'] becomes - * TRUE. - * $item['description'] is translated using t(). - * When doing link translation and the $item['options']['attributes']['title'] - * (link title attribute) matches the description, it is translated as well. */ function _menu_item_localize(&$item, $map, $link_translate = FALSE) { $callback = $item['title_callback']; @@ -929,11 +928,11 @@ function _menu_link_translate(&$item, $translate = FALSE) { * Get a loaded object from a router item. * * menu_get_object() provides access to objects loaded by the current router - * item. For example, on the page node/%node, the router loads the %node object, - * and calling menu_get_object() will return that. Normally, it is necessary to - * specify the type of object referenced, however node is the default. - * The following example tests to see whether the node being displayed is of the - * "story" content type: + * item. For example, on the page node/%node, the router loads the %node + * object, and calling menu_get_object() will return that. Normally, it is + * necessary to specify the type of object referenced, however node is the + * default. The following example tests to see whether the node being + * displayed is of the "story" content type: * @code * $node = menu_get_object(); * $story = $node->type == 'story'; @@ -1173,7 +1172,7 @@ function menu_tree_get_path($menu_name) { } /** - * Get the data structure representing a named menu tree, based on the current page. + * Gets the data structure representing a named menu tree for the current page. * * The tree order is maintained by storing each parent in an individual * field, see http://drupal.org/node/141866 for more. @@ -1184,8 +1183,8 @@ function menu_tree_get_path($menu_name) { * (optional) The maximum depth of links to retrieve. * @param $only_active_trail * (optional) Whether to only return the links in the active trail (TRUE) - * instead of all links on every level of the menu link tree (FALSE). Defaults - * to FALSE. Internally used for breadcrumbs only. + * instead of all links on every level of the menu link tree (FALSE). + * Defaults to FALSE. Internally used for breadcrumbs only. * * @return * An array of menu links, in the order they should be rendered. The array @@ -1322,8 +1321,8 @@ function menu_tree_page_data($menu_name, $max_depth = NULL, $only_active_trail = * trail. This option is ignored, if 'expanded' is non-empty. Internally * used for breadcrumbs. * - min_depth: The minimum depth of menu links in the resulting tree. - * Defaults to 1, which is the default to build a whole tree for a menu, i.e. - * excluding menu container itself. + * Defaults to 1, which is the default to build a whole tree for a menu, + * i.e. excluding menu container itself. * - max_depth: The maximum depth of menu links in the resulting tree. * * @return @@ -1508,8 +1507,8 @@ function _menu_tree_check_access(&$tree) { * is an associative array of information about the menu link, containing the * fields from the {menu_links} table, and optionally additional information * from the {menu_router} table, if the menu item appears in both tables. - * This array must be ordered depth-first. See _menu_build_tree() for a sample - * query. + * This array must be ordered depth-first. See _menu_build_tree() for a + * sample query. * @param $parents * An array of the menu link ID values that are in the path from the current * page to the root of the menu tree. @@ -1522,8 +1521,8 @@ function _menu_tree_check_access(&$tree) { * - link: The menu link item from $links, with additional element * 'in_active_trail' (TRUE if the link ID was in $parents). * - below: An array containing the sub-tree of this item, where each element - * is a tree item array with 'link' and 'below' elements. This array will be - * empty if the menu item has no items in its sub-tree having a depth + * is a tree item array with 'link' and 'below' elements. This array will + * be empty if the menu item has no items in its sub-tree having a depth * greater than or equal to $depth. */ function menu_tree_data(array $links, array $parents = array(), $depth = 1) { @@ -2072,14 +2071,12 @@ function menu_local_tasks($level = 0) { } /** - * Retrieve contextual links for a system object based on registered local tasks. + * Retrieves contextual links based on registered local tasks. * * This leverages the menu system to retrieve the first layer of registered * local tasks for a given system path. All local tasks of the tab type * MENU_CONTEXT_INLINE are taken into account. * - * @see hook_menu() - * * For example, when considering the following registered local tasks: * - node/%node/view (default local task) with no 'context' defined * - node/%node/edit with context: MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE @@ -2106,6 +2103,7 @@ function menu_local_tasks($level = 0) { * @return * A list of menu router items that are local tasks for the passed-in path. * + * @see hook_menu() * @see contextual_links_preprocess() */ function menu_contextual_links($module, $parent_path, $args) { @@ -2200,7 +2198,7 @@ function menu_local_actions() { } /** - * Returns the router path, or the path of the parent tab of a default local task. + * Returns the router path, or the path of the parent for a default local task. */ function menu_tab_root_path() { $links = menu_local_tasks(); @@ -2243,7 +2241,9 @@ function theme_menu_local_tasks(&$variables) { } /** - * Set (or get) the active menu for the current page - determines the active trail. + * Sets (or gets) the active menu for the current page. + * + * This determines the active trail. */ function menu_set_active_menu_names($menu_names = NULL) { $active = &drupal_static(__FUNCTION__); @@ -2281,8 +2281,8 @@ function menu_set_active_item($path) { /** * Sets the active trail (path to menu tree root) of the current page. * - * Any trail set by this function will only be used for functionality that calls - * menu_get_active_trail(). Drupal core only uses trails set here for + * Any trail set by this function will only be used for functionality that + * calls menu_get_active_trail(). Drupal core only uses trails set here for * breadcrumbs and the page title and not for menu trees or page content. * Additionally, breadcrumbs set by drupal_set_breadcrumb() will override any * trail set here. @@ -2455,10 +2455,11 @@ function menu_link_get_preferred($path = NULL) { /** * Gets the active trail (path to root menu root) of the current page. * - * If a trail is supplied to menu_set_active_trail(), that value is returned. If - * a trail is not supplied to menu_set_active_trail(), the path to the current - * page is calculated and returned. The calculated trail is also saved as a - * static value for use by subsequent calls to menu_get_active_trail(). + * If a trail is supplied to menu_set_active_trail(), that value is returned. + * If a trail is not supplied to menu_set_active_trail(), the path to the + * current page is calculated and returned. The calculated trail is also + * saved as a static value for use by subsequent calls to + * menu_get_active_trail(). * * @return * Path to menu root of the current page, as an array of menu link items, @@ -2539,7 +2540,7 @@ function menu_get_active_title() { } /** - * Get a menu link by its mlid, access checked and link translated for rendering. + * Gets a menu link by its mlid, with access checked and the link translated. * * This function should never be called from within node_load() or any other * function used as a menu object load function since an infinite recursion may @@ -3147,6 +3148,7 @@ function menu_link_save(&$item, $existing_item = array(), $parent_candidates = a * A menu link. * @param $parent_candidates * An array of menu links keyed by mlid. + * * @return * A menu link structure of the possible parent or FALSE if no valid parent * has been found. @@ -3212,7 +3214,7 @@ function _menu_link_find_parent($menu_link, $parent_candidates = array()) { } /** - * Helper function to clear the page and block caches at most twice per page load. + * Clears the page and block caches at most twice per page load. */ function _menu_clear_page_cache() { $cache_cleared = &drupal_static(__FUNCTION__, 0); diff --git a/includes/module.inc b/includes/module.inc index e20e164..3f44578 100644 --- a/includes/module.inc +++ b/includes/module.inc @@ -45,19 +45,19 @@ function module_load_all($bootstrap = FALSE) { * after the administrator has changed the system settings). Defaults to * FALSE. * @param $bootstrap_refresh - * (optional) When $refresh is TRUE, setting $bootstrap_refresh to TRUE forces - * the module list to be regenerated using the reduced set of modules loaded - * in "bootstrap mode" for cached pages. Otherwise, setting $refresh to TRUE - * generates the complete list of enabled modules. + * (optional) When $refresh is TRUE, setting $bootstrap_refresh to TRUE + * forces the module list to be regenerated using the reduced set of + * modules loaded in "bootstrap mode" for cached pages. Otherwise, setting + * $refresh to TRUE generates the complete list of enabled modules. * @param $sort * (optional) By default, modules are ordered by weight and module name. Set * this option to TRUE to return a module list ordered only by module name. * @param $fixed_list * (optional) If an array of module names is provided, this will override the - * module list with the given set of modules. This will persist until the next - * call with $refresh set to TRUE or with a new $fixed_list passed in. This - * parameter is primarily intended for internal use (e.g., in install.php and - * update.php). + * module list with the given set of modules. This will persist until the + * next call with $refresh set to TRUE or with a new $fixed_list passed in. + * This parameter is primarily intended for internal use (e.g., in + * install.php and update.php). * * @return * An associative array whose keys and values are the names of the modules in @@ -619,8 +619,8 @@ function module_hook($module, $hook) { * @param $hook * The name of the hook (e.g. "help" or "menu"). * @param $sort - * By default, modules are ordered by weight and filename, settings this option - * to TRUE, module list will be ordered by module name. + * By default, modules are ordered by weight and filename, settings this + * option to TRUE, module list will be ordered by module name. * * @return * An array with the names of the modules which are implementing this hook. @@ -872,9 +872,9 @@ function drupal_required_modules() { * drupal_alter('mymodule_data', $alterable1, $alterable2, $context); * @endcode * - * Note that objects are always passed by reference in PHP5. If it is absolutely - * required that no implementation alters a passed object in $context, then an - * object needs to be cloned: + * Note that objects are always passed by reference in PHP5. If it is + * absolutely required that no implementation alters a passed object in + * $context, then an object needs to be cloned: * @code * $context = array( * 'unalterable_object' => clone $object, @@ -891,8 +891,8 @@ function drupal_required_modules() { * execute both hook_form_alter() and hook_form_FORM_ID_alter() * implementations, it passes array('form', 'form_' . $form_id) for $type. * @param $data - * The variable that will be passed to hook_TYPE_alter() implementations to be - * altered. The type of this variable depends on the value of the $type + * The variable that will be passed to hook_TYPE_alter() implementations to + * be altered. The type of this variable depends on the value of the $type * argument. For example, when altering a 'form', $data will be a structured * array. When altering a 'profile', $data will be an object. * @param $context1