diff options
Diffstat (limited to 'modules/update/update.settings.inc')
| -rw-r--r-- | modules/update/update.settings.inc | 26 |
1 files changed, 17 insertions, 9 deletions
diff --git a/modules/update/update.settings.inc b/modules/update/update.settings.inc index 60ac3ca8e..5cd241498 100644 --- a/modules/update/update.settings.inc +++ b/modules/update/update.settings.inc @@ -6,7 +6,11 @@ */ /** - * Form builder for the update settings tab. + * Form constructor for the update settings form. + * + * @see update_settings_validate() + * @see update_settings_submit() + * @ingroup forms */ function update_settings($form) { $form['update_check_frequency'] = array( @@ -57,9 +61,11 @@ function update_settings($form) { } /** - * Validation callback for the settings form. + * Form validation handler for update_settings(). + * + * Validates the e-mail addresses and ensures the field is formatted correctly. * - * Validates the email addresses and ensures the field is formatted correctly. + * @see update_settings_submit() */ function update_settings_validate($form, &$form_state) { if (!empty($form_state['values']['update_notify_emails'])) { @@ -89,13 +95,15 @@ function update_settings_validate($form, &$form_state) { } /** - * Submit handler for the settings tab. + * Form submission handler for update_settings(). + * + * Also invalidates the cache of available updates if the "Check for updates of + * disabled modules and themes" setting is being changed. The available updates + * report needs to refetch available update data after this setting changes or + * it would show misleading things (e.g., listing the disabled projects on the + * site with the "No available releases found" warning). * - * Also invalidates the cache of available updates if the "Check for updates - * of disabled modules and themes" setting is being changed. The available - * updates report need to refetch available update data after this setting - * changes or it would show misleading things (e.g. listing the disabled - * projects on the site with the "No available releases found" warning). + * @see update_settings_validate() */ function update_settings_submit($form, $form_state) { $op = $form_state['values']['op']; |