diff --git a/core/modules/openid/openid.inc b/core/modules/openid/openid.inc index 23d5252..e4f5e9d 100644 --- a/core/modules/openid/openid.inc +++ b/core/modules/openid/openid.inc @@ -85,7 +85,7 @@ function openid_redirect_http($url, $message) { } /** - * Creates a JavaScript auto-submit redirect for (for the 2.x protocol). + * Creates a JavaScript auto-submit redirect (for the 2.x protocol). * * @param $url * The URL to redirect to. @@ -352,7 +352,7 @@ function _openid_url_normalize($url) { } /** - * Creates a serialized message packet as per spec: $key:$value\n . + * Creates a serialized message packet according to OpenID specifications. * * @param array $data * The message, in the form of key/value pairs. @@ -433,7 +433,7 @@ function _openid_parse_message($message) { } /** - * Generates a nonce value, formatted per OpenID spec. + * Generates a nonce value, formatted per OpenID specifications. * * @return array * The generated nonce. @@ -511,7 +511,8 @@ function _openid_meta_httpequiv($html) { * @param array $message_array * The entire message about to be sent. * @param $keys_to_sign - * Keys in the message to include in signature (without 'openid.' appended). + * Keys in the message to include in the signature + * (without 'openid.' appended). * * @return * The base64 encoded signature. @@ -734,8 +735,8 @@ function _openid_get_bytes($num_bytes) { /** * Obtains the response from the OpenID provider. * - * @param $str - * The string to be populated with raw response data. + * @param string $str + * (optional) The string containing the raw response data. * * @return array * The prepared response data. @@ -896,7 +897,9 @@ function openid_extract_ax_values($values, $uris) { } /** - * Determines the available math library GMP vs. BCMath, favouring GMP for + * Determines the available math library + * + * The function can use either GMP or BCMath, but favors GMP for * performance. * * @return diff --git a/core/modules/openid/openid.module b/core/modules/openid/openid.module index df70c0e..6fc638f 100644 --- a/core/modules/openid/openid.module +++ b/core/modules/openid/openid.module @@ -302,11 +302,12 @@ function openid_form_user_register_form_alter(&$form, &$form_state) { } /** - * Form validation handler for the user login form. + * Form validation handler for openid_user_login(). * * Sets up redirection and starts the OpenID authentication process. * - * @see openid_login_form_submint() + * @see openid_login_form_subint() + * @see openid_user_login() */ function openid_login_validate($form, &$form_state) { $return_to = $form_state['values']['openid.return_to']; @@ -318,18 +319,18 @@ function openid_login_validate($form, &$form_state) { } /** - * The initial step of OpenID authentication. + * Sets up OpenID authentication * * Setup of the OpenID authentication is responsible for the following: - * - Perform discovery on the claimed OpenID. - * - If possible, create an association with the Provider's endpoint. - * - Create the authentication request. - * - Perform the appropriate redirect. + * - Perform discovery on the claimed OpenID. + * - If possible, create an association with the Provider's endpoint. + * - Create the authentication request. + * - Perform the appropriate redirect. * * @param $claimed_id - * The OpenID to authenticate + * The OpenID to authenticate. * @param $return_to - * The endpoint to return to from the OpenID Provider + * The endpoint to return to from the OpenID Provider. */ function openid_begin($claimed_id, $return_to = '', $form_values = array()) { module_load_include('inc', 'openid'); @@ -390,14 +391,13 @@ function openid_begin($claimed_id, $return_to = '', $form_values = array()) { } /** - * Completes authentication by validating response from the OpenID Provider. + * Completes authentication by validating the response from the OpenID Provider. * * @param $response * Array of returned values from the OpenID Provider. * * @return - * Response values for further processing with - * $response['status'] set to one of 'success', 'failed' or 'cancel'. + * $response['status'] - 'success', 'failed', or 'cancel'. */ function openid_complete($response = array()) { module_load_include('inc', 'openid'); @@ -466,7 +466,7 @@ function openid_complete($response = array()) { } /** - * Performs discovery on claimed ID to determine the OpenID provider endpoint. + * Performs discovery on the ID to determine the OpenID provider endpoint. * * Discovery methods are provided by the hook_openid_discovery_method_info and * could be further altered using the hook_openid_discovery_method_info_alter. @@ -502,7 +502,7 @@ function openid_discovery($claimed_id) { } /** - * Implements of hook_openid_discovery_method_info(). + * Implements hook_openid_discovery_method_info(). * * Define standard discovery methods. */ @@ -518,7 +518,7 @@ function openid_openid_discovery_method_info() { } /** - * OpenID discovery method: performs an XRI discovery. + * Performs OpenID discovery via XRI discovery method. * * @param $claimed_id * The Extensible Resource Indicator (XRI) to attempt discovery on. @@ -728,7 +728,7 @@ function openid_association($op_endpoint) { } /** - * Authenticates a user or attempt registration. + * Authenticates a user or attempts registration. * * @param $response * Response values from the OpenID Provider. diff --git a/core/modules/openid/openid.pages.inc b/core/modules/openid/openid.pages.inc index 129dfa8..a43a340 100644 --- a/core/modules/openid/openid.pages.inc +++ b/core/modules/openid/openid.pages.inc @@ -30,7 +30,7 @@ function openid_authentication_page() { * The user account object to manage. * * @return - * A render array for user/%user/openid containing a list of user identities. + * A render array containing a list of user identities. */ function openid_user_identities($account) { drupal_set_title(user_format_name($account)); @@ -118,6 +118,7 @@ function openid_user_add_submit($form, &$form_state) { * The ID of the OpenID identity to delete. * * @see openid_user_delete_form_submit() + * @see openid_menu() * @ingroup forms */ function openid_user_delete_form($form, $form_state, $account, $aid = 0) { @@ -130,9 +131,7 @@ function openid_user_delete_form($form, $form_state, $account, $aid = 0) { } /** - * Form submission handler for openid_user_delete_form(). - * - * @see openid_user_delete_form() + * Form submission handler for openid_user_delete_form(). * */ function openid_user_delete_form_submit($form, &$form_state) { $query = db_delete('authmap')