From 108677607dee12278ec177786ea28ad1b7f3b3d5 Mon Sep 17 00:00:00 2001
From: Angie Byron <webchick@24967.no-reply.drupal.org>
Date: Wed, 5 May 2010 07:10:06 +0000
Subject: [PATCH] #718962 by add1sun, Pasqualle, jhodgdon: Fixed
 user_external_load() is undocumented.

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

diff --git a/modules/user/user.module b/modules/user/user.module
index 0483b5d3353..891bc478cdc 100644
--- a/modules/user/user.module
+++ b/modules/user/user.module
@@ -187,6 +187,15 @@ function user_field_extra_fields() {
   return $return;
 }
 
+/**
+ * Fetches a user object based on an external authentication source.
+ *
+ * @param string $authname
+ *   The external authentication username.
+ *
+ * @return
+ *   A fully-loaded user object if the user is found or FALSE if not found.
+ */
 function user_external_load($authname) {
   $uid = db_query("SELECT uid FROM {authmap} WHERE authname = :authname", array(':authname' => $authname))->fetchField();