From d761ded1f2fe86841f2163ede2d45c00c2839ea7 Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Tue, 2 May 2006 13:26:30 +0000
Subject: - Patch #59763 by Ber: doxygen for user_roles().

---
 modules/user/user.module | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

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

diff --git a/modules/user/user.module b/modules/user/user.module
index 05749c505..47ae006fd 100644
--- a/modules/user/user.module
+++ b/modules/user/user.module
@@ -1680,11 +1680,16 @@ function user_admin_access() {
 }
 
 /**
- * Use this API to retreive an array of all available roles
- * @param $membersonly Set this to TRUE to omit the special role 'anonymous'.
- * @param $permission A string containing a permission. If set, only roles that have that permission are returned.
- * @return An associative array, with the role id as key and the role name as value.
- **/
+ * Retrieve an array of roles matching specified conditions.
+ *
+ * @param $membersonly
+ *   Set this to TRUE to exclude the 'anonymous' role.
+ * @param $permission
+ *   A string containing a permission. If set, only roles containing that permission are returned.
+ *
+ * @return
+ *   An associative array with the role id as the key and the role name as value.
+ */
 function user_roles($membersonly = 0, $permission = 0) {
   $roles = array();
 
-- 
cgit v1.2.3