summaryrefslogtreecommitdiff
path: root/modules/update/update.install
diff options
context:
space:
mode:
Diffstat (limited to 'modules/update/update.install')
-rw-r--r--modules/update/update.install37
1 files changed, 18 insertions, 19 deletions
diff --git a/modules/update/update.install b/modules/update/update.install
index 5e0c75802..117611822 100644
--- a/modules/update/update.install
+++ b/modules/update/update.install
@@ -2,26 +2,25 @@
/**
* @file
- * Install, update and uninstall functions for the update module.
+ * Install, update, and uninstall functions for the Update Manager module.
*/
/**
* Implements hook_requirements().
*
* @return
- * An array describing the status of the site regarding available updates.
- * If there is no update data, only one record will be returned, indicating
- * that the status of core can't be determined. If data is available, there
- * will be two records: one for core, and another for all of contrib
- * (assuming there are any contributed modules or themes enabled on the
- * site). In addition to the fields expected by hook_requirements ('value',
- * 'severity', and optionally 'description'), this array will contain a
- * 'reason' attribute, which is an integer constant to indicate why the
- * given status is being returned (UPDATE_NOT_SECURE, UPDATE_NOT_CURRENT, or
- * UPDATE_UNKNOWN). This is used for generating the appropriate e-mail
- * notification messages during update_cron(), and might be useful for other
- * modules that invoke update_requirements() to find out if the site is up
- * to date or not.
+ * An array describing the status of the site regarding available updates. If
+ * there is no update data, only one record will be returned, indicating that
+ * the status of core can't be determined. If data is available, there will be
+ * two records: one for core, and another for all of contrib (assuming there
+ * are any contributed modules or themes enabled on the site). In addition to
+ * the fields expected by hook_requirements ('value', 'severity', and
+ * optionally 'description'), this array will contain a 'reason' attribute,
+ * which is an integer constant to indicate why the given status is being
+ * returned (UPDATE_NOT_SECURE, UPDATE_NOT_CURRENT, or UPDATE_UNKNOWN). This
+ * is used for generating the appropriate e-mail notification messages during
+ * update_cron(), and might be useful for other modules that invoke
+ * update_requirements() to find out if the site is up to date or not.
*
* @see _update_message_text()
* @see _update_cron_notify()
@@ -96,19 +95,19 @@ function update_uninstall() {
}
/**
- * Private helper method to fill in the requirements array.
+ * Fills in the requirements array.
*
* This is shared for both core and contrib to generate the right elements in
* the array for hook_requirements().
*
* @param $project
- * Array of information about the project we're testing as returned by
- * update_calculate_project_data().
+ * Array of information about the project we're testing as returned by
+ * update_calculate_project_data().
* @param $type
- * What kind of project is this ('core' or 'contrib').
+ * What kind of project this is ('core' or 'contrib').
*
* @return
- * An array to be included in the nested $requirements array.
+ * An array to be included in the nested $requirements array.
*
* @see hook_requirements()
* @see update_requirements()