Add documentation for EditMember and EditProfile

2 files changed, 15 insertions, 0 deletions

diff --git a/src/utils/builder/edit_member.rs b/src/utils/builder/edit_member.rs
index c26cb84..845b43d 100644
--- a/src/utils/builder/edit_member.rs
+++ b/src/utils/builder/edit_member.rs
@@ -2,27 +2,38 @@ use serde_json::builder::ObjectBuilder;
 use std::default::Default;
 use ::model::{ChannelId, RoleId};
 
+/// A builder which edits the properties of a [`Member`], to be used in
+/// conjunction with [`Context::edit_member`].
+///
+/// [`Context::edit_member`]: ../../client/struct.Context.html#method.edit_member
+/// [`Member`]: ../../model/struct.Member.html
 pub struct EditMember(pub ObjectBuilder);
 
 impl EditMember {
+    /// Whether to deafen the member.
     pub fn deafen(self, deafen: bool) -> Self {
         EditMember(self.0.insert("deaf", deafen))
     }
 
+    /// Whether to mute the member.
     pub fn mute(self, mute: bool) -> Self {
         EditMember(self.0.insert("mute", mute))
     }
 
+    /// Changes the member's nickname. Pass an empty string to reset the
+    /// nickname.
     pub fn nickname(self, nickname: &str) -> Self {
         EditMember(self.0.insert("nick", nickname))
     }
 
+    /// Set the list of roles that the member should have.
     pub fn roles(self, roles: &[RoleId]) -> Self {
         EditMember(self.0
             .insert_array("roles",
                           |a| roles.iter().fold(a, |a, id| a.push(id.0))))
     }
 
+    /// The Id of the voice channel to move the member to.
     pub fn voice_channel<C: Into<ChannelId>>(self, channel_id: C) -> Self {
         EditMember(self.0.insert("channel_id", channel_id.into().0))
     }
diff --git a/src/utils/builder/edit_profile.rs b/src/utils/builder/edit_profile.rs
index 4517ae2..e7c4637 100644
--- a/src/utils/builder/edit_profile.rs
+++ b/src/utils/builder/edit_profile.rs
@@ -2,6 +2,10 @@ use serde_json::builder::ObjectBuilder;
 use serde_json::Value;
 use std::default::Default;
 
+/// A builder to edit the current user's settings, to be used in conjunction
+/// with [`Context::edit_profile`].
+///
+/// [`Context::edit_profile`]: ../../client/struct.Context.html#method.edit_profile
 pub struct EditProfile(pub ObjectBuilder);
 
 impl EditProfile {