diff options
| author | Dries Buytaert <dries@buytaert.net> | 2006-05-02 13:26:30 +0000 |
|---|---|---|
| committer | Dries Buytaert <dries@buytaert.net> | 2006-05-02 13:26:30 +0000 |
| commit | d761ded1f2fe86841f2163ede2d45c00c2839ea7 (patch) | |
| tree | 6c7e003e5921fba3f819114121c04e4e356b4569 | |
| parent | 6411e09dc9cae887c99db3e8c5d49f8d69ca8f01 (diff) | |
| download | brdo-d761ded1f2fe86841f2163ede2d45c00c2839ea7.tar.gz brdo-d761ded1f2fe86841f2163ede2d45c00c2839ea7.tar.bz2 | |
- Patch #59763 by Ber: doxygen for user_roles().
| -rw-r--r-- | modules/user.module | 15 | ||||
| -rw-r--r-- | modules/user/user.module | 15 |
2 files changed, 20 insertions, 10 deletions
diff --git a/modules/user.module b/modules/user.module index 05749c505..47ae006fd 100644 --- a/modules/user.module +++ b/modules/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(); 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(); |