From dc4acbcb93188ea49e277c4b46aac64613b268b0 Mon Sep 17 00:00:00 2001
From: Gerhard Killesreiter <killes_www_drop_org@227.no-reply.drupal.org>
Date: Wed, 26 Apr 2006 11:07:25 +0000
Subject: #59763, doxygen for user_roles, patch by Ber

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

(limited to 'modules/user.module')

diff --git a/modules/user.module b/modules/user.module
index 0f99be598..f87be38aa 100644
--- a/modules/user.module
+++ b/modules/user.module
@@ -1671,6 +1671,12 @@ function user_admin_access() {
   return $output;
 }
 
+/**
+ * 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.
+ **/
 function user_roles($membersonly = 0, $permission = 0) {
   $roles = array();
 
-- 
cgit v1.2.3