diff options
| author | David Rothstein <drothstein@gmail.com> | 2016-02-02 00:03:14 -0500 |
|---|---|---|
| committer | David Rothstein <drothstein@gmail.com> | 2016-02-02 00:03:14 -0500 |
| commit | 98229c422aeb43337c8930b03cf651b8660b8c83 (patch) | |
| tree | fa3b7eb69f0ce37b11a52f59927075c4f245e1d4 /includes | |
| parent | 70aafbab880d9c67b91cb3c18c01b3e13a60df8b (diff) | |
| download | brdo-98229c422aeb43337c8930b03cf651b8660b8c83.tar.gz brdo-98229c422aeb43337c8930b03cf651b8660b8c83.tar.bz2 | |
Issue #2645544 by Liam Morland: Improve documentation for module_disable() and related functions
Diffstat (limited to 'includes')
| -rw-r--r-- | includes/install.inc | 3 | ||||
| -rw-r--r-- | includes/module.inc | 15 |
2 files changed, 12 insertions, 6 deletions
diff --git a/includes/install.inc b/includes/install.inc index 2b55589f8..5e1d3c632 100644 --- a/includes/install.inc +++ b/includes/install.inc @@ -750,7 +750,7 @@ function drupal_install_system() { /** * Uninstalls a given list of disabled modules. * - * @param array $module_list + * @param string[] $module_list * The modules to uninstall. It is the caller's responsibility to ensure that * all modules in this list have already been disabled before this function * is called. @@ -769,6 +769,7 @@ function drupal_install_system() { * included in $module_list). * * @see module_disable() + * @see module_enable() */ function drupal_uninstall_modules($module_list = array(), $uninstall_dependents = TRUE) { if ($uninstall_dependents) { diff --git a/includes/module.inc b/includes/module.inc index 0589ba787..68c8b8ef4 100644 --- a/includes/module.inc +++ b/includes/module.inc @@ -376,20 +376,22 @@ function module_load_all_includes($type, $name = NULL) { * - Invoke hook_modules_installed(). * - Invoke hook_modules_enabled(). * - * @param $module_list + * @param string[] $module_list * An array of module names. - * @param $enable_dependencies + * @param bool $enable_dependencies * If TRUE, dependencies will automatically be added and enabled in the * correct order. This incurs a significant performance cost, so use FALSE * if you know $module_list is already complete and in the correct order. * - * @return + * @return bool * FALSE if one or more dependencies are missing, TRUE otherwise. * * @see hook_install() * @see hook_enable() * @see hook_modules_installed() * @see hook_modules_enabled() + * @see module_disable() + * @see drupal_uninstall_modules() */ function module_enable($module_list, $enable_dependencies = TRUE) { if ($enable_dependencies) { @@ -516,12 +518,15 @@ function module_enable($module_list, $enable_dependencies = TRUE) { /** * Disables a given set of modules. * - * @param $module_list + * @param string[] $module_list * An array of module names. - * @param $disable_dependents + * @param bool $disable_dependents * If TRUE, dependent modules will automatically be added and disabled in the * correct order. This incurs a significant performance cost, so use FALSE * if you know $module_list is already complete and in the correct order. + * + * @see drupal_uninstall_modules() + * @see module_enable() */ function module_disable($module_list, $disable_dependents = TRUE) { if ($disable_dependents) { |