aboutsummaryrefslogtreecommitdiff
path: root/src/model/permissions.rs
diff options
context:
space:
mode:
authorZeyla Hellyer <[email protected]>2017-03-25 15:35:50 -0700
committerZeyla Hellyer <[email protected]>2017-03-25 15:35:50 -0700
commit356c9c0d42f4b0583a2c7b5333196c4f4e6a73cc (patch)
treefe4296b5c07b32be2c3a7d1f2169fe3f00c1a415 /src/model/permissions.rs
parentFix Member methods due to variant joined_at values (diff)
downloadserenity-356c9c0d42f4b0583a2c7b5333196c4f4e6a73cc.tar.xz
serenity-356c9c0d42f4b0583a2c7b5333196c4f4e6a73cc.zip
Add slightly more documentation
Diffstat (limited to 'src/model/permissions.rs')
-rw-r--r--src/model/permissions.rs10
1 files changed, 9 insertions, 1 deletions
diff --git a/src/model/permissions.rs b/src/model/permissions.rs
index 1c613d3..98400c6 100644
--- a/src/model/permissions.rs
+++ b/src/model/permissions.rs
@@ -145,8 +145,16 @@ pub fn voice() -> Permissions {
CONNECT | SPEAK | USE_VAD
}
-
bitflags! {
+ /// A set of permissions that can be assigned to [`User`]s and [`Role`]s via
+ /// [`PermissionOverwrite`]s, roles globally in a [`Guild`], and to
+ /// [`GuildChannel`]s.
+ ///
+ /// [`Guild`]: struct.Guild.html
+ /// [`GuildChannel`]: struct.GuildChannel.html
+ /// [`PermissionOverwrite`]: struct.PermissionOverwrite.html
+ /// [`Role`]: struct.Role.html
+ /// [`User`]: struct.User.html
pub flags Permissions: u64 {
/// Allows for the creation of [`RichInvite`]s.
///