summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Rothstein2015-01-27 18:30:00 (GMT)
committerDavid Rothstein2015-01-27 18:30:00 (GMT)
commit997d82dce1a4269a9cee32d3f6b2ec2b90a80b33 (patch)
treebeacbb091000efb9c7c0cbff87bf605bf7ebe126
parent7a70138a1a06cbaa8cf7599bb1ed5d42a9fd0efc (diff)
Issue #2415223: Fix documentation of form API functions to match coding standards.HEAD7.x-1.x
-rw-r--r--user_cancel_password_confirm.module10
1 files changed, 8 insertions, 2 deletions
diff --git a/user_cancel_password_confirm.module b/user_cancel_password_confirm.module
index d99d82b..8ca52a0 100644
--- a/user_cancel_password_confirm.module
+++ b/user_cancel_password_confirm.module
@@ -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;