### Eclipse Workspace Patch 1.0 #P Drupal-7-HEAD Index: includes/module.inc =================================================================== RCS file: /cvs/drupal/drupal/includes/module.inc,v retrieving revision 1.198 diff -u -r1.198 module.inc --- includes/module.inc 3 Sep 2010 19:49:55 -0000 1.198 +++ includes/module.inc 30 Sep 2010 06:45:05 -0000 @@ -819,7 +819,7 @@ * @endcode * * @param $type - * A string describing the data type of the alterable $data. 'form', 'links', + * A string describing the type of the alterable $data. 'form', 'links', * 'node_content', and so on are several examples. Alternatively can be an * array, in which case hook_TYPE_alter() is invoked for each value in the * array, ordered first by module, and then for each module, in the order of @@ -827,13 +827,16 @@ * execute both hook_form_alter() and hook_form_FORM_ID_alter() * implementations, it passes array('form', 'form_' . $form_id) for $type. * @param &$data - * The primary data to be altered. + * The variable that will be passed to hook_TYPE_alter() implementations to be + * altered. The type of this variable depends on the value of the $type + * argument. For example, when altering a 'form', $data will be a structured + * array. When altering a 'profile', $data will be an object. * @param &$context1 * (optional) An additional variable that is passed by reference. * @param &$context2 * (optional) An additional variable that is passed by reference. If more * context needs to be provided to implementations, then this should be an - * keyed array as described above. + * associative array as described above. */ function drupal_alter($type, &$data, &$context1 = NULL, &$context2 = NULL) { // Use the advanced drupal_static() pattern, since this is called very often.