From 2af199525071320f2ec53fca590fbf31ba9c56fd Mon Sep 17 00:00:00 2001
From: Jennifer Hodgdon <yahgrp@poplarware.com>
Date: Thu, 6 Dec 2012 13:41:22 -0800
Subject: [PATCH] Issue #1247812 by Albert Volkman, jzacsh: Add docs for
 user_admin() function

---
 modules/user/user.admin.inc | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/modules/user/user.admin.inc b/modules/user/user.admin.inc
index 1cc2c4a2455..932c205934d 100644
--- a/modules/user/user.admin.inc
+++ b/modules/user/user.admin.inc
@@ -5,6 +5,21 @@
  * Admin page callback file for the user module.
  */
 
+/**
+ * Page callback: Generates the appropriate user administration form.
+ *
+ * This function generates the user registration, multiple user cancellation,
+ * or filtered user list admin form, depending on the argument and the POST
+ * form values.
+ *
+ * @param string $callback_arg
+ *   (optional) Indicates which form to build. Defaults to '', which will
+ *   trigger the user filter form. If the POST value 'op' is present, this
+ *   function uses that value as the callback argument.
+ *
+ * @return string
+ *   A renderable form array for the respective request.
+ */
 function user_admin($callback_arg = '') {
   $op = isset($_POST['op']) ? $_POST['op'] : $callback_arg;