From 08a07d779575a8c3c28b48060f3273ca398bdce7 Mon Sep 17 00:00:00 2001
From: Angie Byron <webchick@24967.no-reply.drupal.org>
Date: Wed, 5 May 2010 07:04:17 +0000
Subject: #764426 by aaronmontana, rickvug: Fixed user_validate_mail() is
 undocumented.

---
 modules/user/user.module | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'modules/user/user.module')

diff --git a/modules/user/user.module b/modules/user/user.module
index 0f3318cde..0483b5d33 100644
--- a/modules/user/user.module
+++ b/modules/user/user.module
@@ -575,6 +575,19 @@ function user_validate_name($name) {
   }
 }
 
+/**
+ * Validates a user's email address.
+ *
+ * Checks that a user's email address exists and follows all standard
+ * validation rules. Returns error messages when the address is invalid.
+ *
+ * @param $mail
+ *   A user's email address.
+ *
+ * @return
+ *   If the address is invalid, a human-readable error message is returned.
+ *   If the address is valid, nothing is returned.
+ */
 function user_validate_mail($mail) {
   $mail = trim($mail);
   if (!$mail) {
-- 
cgit v1.2.3