From 582b6df28e2c2e315b58e131765661dd5c2c226b Mon Sep 17 00:00:00 2001 From: markpavlitski Date: Thu, 2 May 2013 16:07:50 +0100 Subject: [PATCH] Issue #1984190 by markpavlitski: Reformatted hook_install_tasks() documentation. --- core/modules/system/system.api.php | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/core/modules/system/system.api.php b/core/modules/system/system.api.php index 9d6922c..1f6f1e3 100644 --- a/core/modules/system/system.api.php +++ b/core/modules/system/system.api.php @@ -2923,31 +2923,32 @@ function hook_disable() { * A string representing the type of task. This parameter has three * possible values: * - 'normal': This indicates that the task will be treated as a regular - * callback function, which does its processing and optionally returns - * HTML output. This is the default behavior which is used when 'type' is - * not set. + * callback function, which does its processing and optionally returns + * HTML output. This is the default behavior which is used when 'type' + * is not set. * - 'batch': This indicates that the task function will return a batch - * API definition suitable for batch_set(). The installer will then take - * care of automatically running the task via batch processing. + * API definition suitable for batch_set(). The installer will then + * take care of automatically running the task via batch processing. * - 'form': This indicates that the task function will return a standard - * form API definition (and separately define validation and submit - * handlers, as appropriate). The installer will then take care of - * automatically directing the user through the form submission process. + * form API definition (and separately define validation and submit + * handlers, as appropriate). The installer will then take care of + * automatically directing the user through the form submission + * process. * - 'run' * A constant representing the manner in which the task will be run. This * parameter has three possible values: * - INSTALL_TASK_RUN_IF_NOT_COMPLETED: This indicates that the task will - * run once during the installation of the profile. This is the default - * behavior which is used when 'run' is not set. + * run once during the installation of the profile. This is the default + * behavior which is used when 'run' is not set. * - INSTALL_TASK_SKIP: This indicates that the task will not run during - * the current installation page request. It can be used to skip running - * an installation task when certain conditions are met, even though the - * task may still show on the list of installation tasks presented to the - * user. + * the current installation page request. It can be used to skip + * running an installation task when certain conditions are met, even + * though the task may still show on the list of installation tasks + * presented to the user. * - INSTALL_TASK_RUN_IF_REACHED: This indicates that the task will run - * on each installation page request that reaches it. This is rarely - * necessary for an installation profile to use; it is primarily used by - * the Drupal installer for bootstrap-related tasks. + * on each installation page request that reaches it. This is rarely + * necessary for an installation profile to use; it is primarily used + * by the Drupal installer for bootstrap-related tasks. * - 'function' * Normally this does not need to be set, but it can be used to force the * installer to call a different function when the task is run (rather -- 1.8.1.2