Commit cabfacca authored by Dries's avatar Dries

- Patch #1024684 by linclark: omit & in @param statements.

parent 6f707762
......@@ -159,7 +159,7 @@ function _authorize_filetransfer_connection_settings($backend) {
* Therefore, to properly add defaults, we need to walk through all the
* children form elements and process those defaults recursively.
*
* @param &$element
* @param $element
* Reference to the Form API form element we're operating on.
* @param $key
* The key for our current form element, if any.
......
......@@ -6311,7 +6311,7 @@ function drupal_array_set_nested_value(array &$array, array $parents, $value, $f
* The array from which to get the value.
* @param $parents
* An array of parent keys of the value, starting with the outermost key.
* @param &$key_exists
* @param $key_exists
* (optional) If given, an already defined variable that is altered by
* reference.
*
......
......@@ -422,7 +422,7 @@ function file_create_url($uri) {
* Directories need to have execute permissions to be considered a directory by
* FTP servers, etc.
*
* @param &$directory
* @param $directory
* A string reference containing the name of a directory path or URI. A
* trailing slash will be trimmed from a path.
* @param $options
......
......@@ -201,7 +201,7 @@ function drupal_get_form($form_id) {
* can implement hook_forms(), which maps different $form_id values to the
* proper form constructor function. Examples may be found in node_forms(),
* search_forms(), and user_forms().
* @param &$form_state
* @param $form_state
* An array which stores information about the form. This is passed as a
* reference so that the caller can use it to examine what in the form changed
* when the form submission process is complete. Furthermore, it may be used
......@@ -2061,7 +2061,7 @@ function _form_button_was_clicked($element, &$form_state) {
* - form_build_id
* - op
*
* @param &$form_state
* @param $form_state
* A keyed array containing the current state of the form, including
* submitted form values; altered by reference.
*/
......@@ -3377,7 +3377,7 @@ function form_validate_machine_name(&$element, &$form_state) {
* Adds fieldsets to the specified group or adds group members to this
* fieldset.
*
* @param &$element
* @param $element
* An associative array containing the properties and children of the
* fieldset. Note that $element must be taken by reference here, so processed
* child elements are taken over into $form_state.
......@@ -3955,7 +3955,7 @@ function theme_form_element_label($variables) {
*
* Adds 'required' and 'error' classes as needed.
*
* @param &$element
* @param $element
* The form element.
* @param $name
* Array of new class names to be added.
......
......@@ -74,15 +74,15 @@ function drupal_depth_first_search(&$graph) {
/**
* Helper function to perform a depth first sort.
*
* @param &$graph
* @param $graph
* A three dimensional associated graph array.
* @param &$state
* @param $state
* An associative array. The key 'last_visit_order' stores a list of the
* vertices visited. The key components stores list of vertices belonging
* to the same the component.
* @param $start
* An arbitrary vertex where we started traversing the graph.
* @param &$component
* @param $component
* The component of the last vertex.
*
* @see drupal_depth_first_search()
......
......@@ -890,14 +890,14 @@ function drupal_required_modules() {
* values in $type. For example, when Form API is using drupal_alter() to
* execute both hook_form_alter() and hook_form_FORM_ID_alter()
* implementations, it passes array('form', 'form_' . $form_id) for $type.
* @param &$data
* @param $data
* 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
* @param $context1
* (optional) An additional variable that is passed by reference.
* @param &$context2
* @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
* associative array as described above.
......
......@@ -383,7 +383,7 @@ protected function getLocalPath($uri = NULL) {
* The file mode ("r", "wb" etc.).
* @param $options
* A bit mask of STREAM_USE_PATH and STREAM_REPORT_ERRORS.
* @param &$opened_path
* @param $opened_path
* A string containing the path actually opened.
*
* @return
......
......@@ -169,7 +169,7 @@ function unicode_requirements() {
* This is also where unsupported encodings will be converted. Callers should
* take this into account: $data might have been changed after the call.
*
* @param &$data
* @param $data
* The XML data which will be parsed later.
*
* @return
......
......@@ -1318,7 +1318,7 @@ function hook_field_attach_view_alter(&$output, $context) {
*
* This hook is invoked after the field module has performed the operation.
*
* @param &$entity
* @param $entity
* The entity being prepared for translation.
* @param $context
* An associative array containing:
......@@ -1361,7 +1361,7 @@ function hook_field_language_alter(&$display_language, $context) {
* This hook is invoked from field_available_languages() to allow modules to
* alter the array of available languages for the given field.
*
* @param &$languages
* @param $languages
* A reference to an array of language codes to be made available.
* @param $context
* An associative array containing:
......
......@@ -41,7 +41,7 @@ function hook_file_download_access($field, $entity_type, $entity) {
*
* @see hook_file_download_access().
*
* @param &$grants
* @param $grants
* An array of grants gathered by hook_file_download_access(). The array is
* keyed by the module that defines the entity type's access control; the
* values are Boolean grant responses for each module.
......
......@@ -379,7 +379,7 @@ class MenuTestCase extends DrupalWebTestCase {
/**
* Modify a menu link using the menu module UI.
*
* @param array &$item Menu link passed by reference.
* @param array $item Menu link passed by reference.
*/
function modifyMenuLink(&$item) {
$item['link_title'] = $this->randomName(16);
......
......@@ -314,7 +314,7 @@ function hook_node_access_records($node) {
* @see hook_node_grants()
* @see hook_node_grants_alter()
*
* @param &$grants
* @param $grants
* The $grants array returned by hook_node_access_records().
* @param $node
* The node for which the grants were acquired.
......@@ -359,7 +359,7 @@ function hook_node_access_records_alter(&$grants, $node) {
* @see hook_node_access_records()
* @see hook_node_access_records_alter()
*
* @param &$grants
* @param $grants
* The $grants array returned by hook_node_grants().
* @param $account
* The user account requesting access to content.
......
......@@ -651,7 +651,7 @@ function hook_element_info() {
* A module may implement this hook in order to alter the element type defaults
* defined by a module.
*
* @param &$type
* @param $type
* All element type defaults as collected by hook_element_info().
*
* @see hook_element_info()
......@@ -1840,7 +1840,7 @@ function hook_mail_alter(&$message) {
* hook in order to reorder the implementing modules, which are otherwise
* ordered by the module's system weight.
*
* @param &$implementations
* @param $implementations
* An array keyed by the module's name. The value of each item corresponds
* to a $group, which is usually FALSE, unless the implementation is in a
* file named $module.$group.inc.
......@@ -1867,7 +1867,7 @@ function hook_module_implements_alter(&$implementations, $hook) {
* add to or alter the data generated by reading the .info file with
* drupal_parse_info_file().
*
* @param &$info
* @param $info
* The .info file contents, passed by reference so that it can be altered.
* @param $file
* Full information about the module or theme, including $file->name, and
......@@ -3517,11 +3517,11 @@ function hook_install_tasks() {
/**
* Change the page the user is sent to by drupal_goto().
*
* @param &$path
* @param $path
* A Drupal path or a full URL.
* @param &$options
* @param $options
* An associative array of additional URL options to pass to url().
* @param &$http_response_code
* @param $http_response_code
* The HTTP status code to use for the redirection. See drupal_goto() for more
* information.
*/
......@@ -3990,7 +3990,7 @@ function hook_url_outbound_alter(&$path, &$options, $original_path) {
* displayed. Can be used to ensure user privacy in situations where
* $account->name is too revealing.
*
* @param &$name
* @param $name
* The string that format_username() will return.
*
* @param $account
......
......@@ -101,7 +101,7 @@ function update_authorize_run_install($filetransfer, $project, $updater_name, $l
* already been downloaded and extracted into.
* @param FileTransfer $filetransfer
* The FileTransfer object to use for performing this operation.
* @param array &$context
* @param array $context
* Reference to an array used for BatchAPI storage.
*/
function update_authorize_batch_copy_project($project, $updater_name, $local_url, $filetransfer, &$context) {
......
......@@ -855,7 +855,7 @@ function update_manager_file_get($url) {
* The short name of the project to download.
* @param string $url
* The URL to download a specific project release archive file.
* @param array &$context
* @param array $context
* Reference to an array used for BatchAPI storage.
*
* @see update_manager_download_page()
......
......@@ -126,7 +126,7 @@ function hook_user_cancel($edit, $account, $method) {
* a method. If #access is defined, the method cannot be configured as default
* method.
*
* @param &$methods
* @param $methods
* An array containing user account cancellation methods, keyed by method id.
*
* @see user_cancel_methods()
......@@ -213,7 +213,7 @@ function hook_user_categories() {
* user account object is loaded, modules may add to $edit['data'] in order
* to have their data serialized on save.
*
* @param &$edit
* @param $edit
* The array of form values submitted by the user.
* @param $account
* The user object on which the operation is performed.
......@@ -236,7 +236,7 @@ function hook_user_presave(&$edit, $account, $category) {
* The module should save its custom additions to the user object into the
* database.
*
* @param &$edit
* @param $edit
* The array of form values submitted by the user.
* @param $account
* The user object on which the operation is being performed.
......@@ -261,7 +261,7 @@ function hook_user_insert(&$edit, $account, $category) {
* Modules may use this hook to update their user data in a custom storage
* after a user account has been updated.
*
* @param &$edit
* @param $edit
* The array of form values submitted by the user.
* @param $account
* The user object on which the operation is performed.
......@@ -283,7 +283,7 @@ function hook_user_update(&$edit, $account, $category) {
/**
* The user just logged in.
*
* @param &$edit
* @param $edit
* The array of form values submitted by the user.
* @param $account
* The user object on which the operation was just performed.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment