Commit 997d82dc authored by David_Rothstein's avatar David_Rothstein

Issue #2415223: Fix documentation of form API functions to match coding standards.

parent 7a70138a
......@@ -35,7 +35,10 @@ function user_cancel_password_confirm_form_user_cancel_confirm_form_alter(&$form
}
/**
* Validation for the current password field on the user cancellation form.
* Form API callback: Validates the password on the user cancellation form.
*
* This function is assigned as an #element_validate callback in
* user_cancel_password_confirm_form_user_cancel_confirm_form_alter().
*/
function user_cancel_password_confirm_validate($element, &$form_state, $complete_form) {
// Check the current user's password (not the account being deleted). This
......@@ -48,7 +51,10 @@ function user_cancel_password_confirm_validate($element, &$form_state, $complete
}
/**
* Replacement submit handler for the user cancellation form.
* Replacement form submission handler for user_cancel_confirm_form().
*
* @see user_cancel_confirm_form()
* @see user_cancel_password_confirm_form_user_cancel_confirm_form_alter()
*/
function user_cancel_password_confirm_submit($form, &$form_state) {
global $user;
......
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