diff options
Diffstat (limited to 'modules/system')
-rw-r--r-- | modules/system/language.api.php | 10 | ||||
-rw-r--r-- | modules/system/system.api.php | 33 | ||||
-rw-r--r-- | modules/system/system.install | 7 | ||||
-rw-r--r-- | modules/system/system.mail.inc | 2 | ||||
-rw-r--r-- | modules/system/system.module | 15 |
5 files changed, 37 insertions, 30 deletions
diff --git a/modules/system/language.api.php b/modules/system/language.api.php index d868b6fef..f8e6a256d 100644 --- a/modules/system/language.api.php +++ b/modules/system/language.api.php @@ -118,11 +118,11 @@ function hook_language_types_info_alter(array &$language_types) { * will be available for all the configurable language types. * - callbacks: An associative array of functions that will be called to * perform various tasks. Possible elements are: - * - negotiation: (required) Name of the callback function that determines - * the language value. - * - language_switch: (optional) Name of the callback function that - * determines links for a language switcher block associated with this - * provider. See language_switcher_url() for an example. + * - language: (required) Name of the callback function that determines the + * language value. + * - switcher: (optional) Name of the callback function that determines + * links for a language switcher block associated with this provider. See + * language_switcher_url() for an example. * - url_rewrite: (optional) Name of the callback function that provides URL * rewriting, if needed by this provider. * - file: The file where callback functions are defined (this file will be diff --git a/modules/system/system.api.php b/modules/system/system.api.php index 2c529d480..276dbca18 100644 --- a/modules/system/system.api.php +++ b/modules/system/system.api.php @@ -607,8 +607,7 @@ function hook_cron() { * An associative array where the key is the queue name and the value is * again an associative array. Possible keys are: * - 'worker callback': The name of the function to call. It will be called - * with one argument, the item created via DrupalQueue::createItem() in - * hook_cron(). + * with one argument, the item created via DrupalQueue::createItem(). * - 'time': (optional) How much time Drupal should spend on calling this * worker in seconds. Defaults to 15. * @@ -3098,37 +3097,39 @@ function hook_requirements($phase) { /** * Define the current version of the database schema. * - * A Drupal schema definition is an array structure representing one or - * more tables and their related keys and indexes. A schema is defined by + * A Drupal schema definition is an array structure representing one or more + * tables and their related keys and indexes. A schema is defined by * hook_schema() which must live in your module's .install file. * - * This hook is called at install and uninstall time, and in the latter - * case, it cannot rely on the .module file being loaded or hooks being known. - * If the .module file is needed, it may be loaded with drupal_load(). + * This hook is called at install and uninstall time, and in the latter case, it + * cannot rely on the .module file being loaded or hooks being known. If the + * .module file is needed, it may be loaded with drupal_load(). * - * The tables declared by this hook will be automatically created when - * the module is first enabled, and removed when the module is uninstalled. - * This happens before hook_install() is invoked, and after hook_uninstall() - * is invoked, respectively. + * The tables declared by this hook will be automatically created when the + * module is first enabled, and removed when the module is uninstalled. This + * happens before hook_install() is invoked, and after hook_uninstall() is + * invoked, respectively. * * By declaring the tables used by your module via an implementation of * hook_schema(), these tables will be available on all supported database * engines. You don't have to deal with the different SQL dialects for table * creation and alteration of the supported database engines. * - * See the Schema API Handbook at http://drupal.org/node/146843 for - * details on schema definition structures. + * See the Schema API Handbook at http://drupal.org/node/146843 for details on + * schema definition structures. * - * @return + * @return array * A schema definition structure array. For each element of the * array, the key is a table name and the value is a table structure * definition. * + * @see hook_schema_alter() + * * @ingroup schemaapi */ function hook_schema() { $schema['node'] = array( - // example (partial) specification for table "node" + // Example (partial) specification for table "node". 'description' => 'The base table for nodes.', 'fields' => array( 'nid' => array( @@ -4095,7 +4096,7 @@ function hook_date_format_types_alter(&$types) { * declared in an implementation of hook_date_format_types(). * - 'format': A PHP date format string to use when formatting dates. It * can contain any of the formatting options described at - * http://php.net/manual/en/function.date.php + * http://php.net/manual/function.date.php * - 'locales': (optional) An array of 2 and 5 character locale codes, * defining which locales this format applies to (for example, 'en', * 'en-us', etc.). If your date format is not language-specific, leave this diff --git a/modules/system/system.install b/modules/system/system.install index afe4ebc0e..7d3c95916 100644 --- a/modules/system/system.install +++ b/modules/system/system.install @@ -6,12 +6,7 @@ */ /** - * Test and report Drupal installation requirements. - * - * @param $phase - * The current system installation phase. - * @return - * An array of system requirements. + * Implements hook_requirements(). */ function system_requirements($phase) { global $base_url; diff --git a/modules/system/system.mail.inc b/modules/system/system.mail.inc index 4e7544006..443e57400 100644 --- a/modules/system/system.mail.inc +++ b/modules/system/system.mail.inc @@ -31,7 +31,7 @@ class DefaultMailSystem implements MailSystemInterface { /** * Send an e-mail message, using Drupal variables and default settings. * - * @see http://php.net/manual/en/function.mail.php + * @see http://php.net/manual/function.mail.php * @see drupal_mail() * * @param $message diff --git a/modules/system/system.module b/modules/system/system.module index 2bbcd7fcf..eada9ffc2 100644 --- a/modules/system/system.module +++ b/modules/system/system.module @@ -2730,7 +2730,17 @@ function system_default_region($theme) { } /** - * Add default buttons to a form and set its prefix. + * Sets up a form to save information automatically. + * + * This function adds a submit handler and a submit button to a form array. The + * submit function saves all the data in the form, using variable_set(), to + * variables named the same as the keys in the form array. Note that this means + * you should normally prefix your form array keys with your module name, so + * that they are unique when passed into variable_set(). + * + * If you need to manipulate the data in a custom manner, you can either put + * your own submission handler in the form array before calling this function, + * or just use your own submission handler instead of calling this function. * * @param $form * An associative array containing the structure of the form. @@ -2739,6 +2749,7 @@ function system_default_region($theme) { * The form structure. * * @see system_settings_form_submit() + * * @ingroup forms */ function system_settings_form($form) { @@ -2757,7 +2768,7 @@ function system_settings_form($form) { } /** - * Execute the system_settings_form. + * Form submission handler for system_settings_form(). * * If you want node type configure style handling of your checkboxes, * add an array_filter value to your form. |