From c420c87bf5d7d15c80fc599e7c3a0a038204fadb Mon Sep 17 00:00:00 2001
From: Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
Date: Fri, 2 Nov 2018 16:28:40 +0100
Subject: [PATCH] muc: Document more constructors.

---
 src/muc/muc.rs | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/muc/muc.rs b/src/muc/muc.rs
index def14bae..5e5d65e8 100644
--- a/src/muc/muc.rs
+++ b/src/muc/muc.rs
@@ -28,6 +28,7 @@ generate_element!(
 );
 
 impl History {
+    /// Create a new empty history element.
     pub fn new() -> Self {
         History {
             maxchars: None,
@@ -37,21 +38,25 @@ impl History {
         }
     }
 
+    /// Set how many characters of history to send.
     pub fn with_maxchars(mut self, maxchars: u32) -> Self {
         self.maxchars = Some(maxchars);
         self
     }
 
+    /// Set how many messages to send.
     pub fn with_maxstanzas(mut self, maxstanzas: u32) -> Self {
         self.maxstanzas = Some(maxstanzas);
         self
     }
 
+    /// Only send messages received in these last seconds.
     pub fn with_seconds(mut self, seconds: u32) -> Self {
         self.seconds = Some(seconds);
         self
     }
 
+    /// Only send messages received since this date.
     pub fn with_since(mut self, since: DateTime) -> Self {
         self.since = Some(since);
         self
@@ -73,6 +78,7 @@ generate_element!(
 impl PresencePayload for Muc {}
 
 impl Muc {
+    /// Create a new MUC join element.
     pub fn new() -> Self {
         Muc {
             password: None,
@@ -80,11 +86,13 @@ impl Muc {
         }
     }
 
+    /// Join a room with this password.
     pub fn with_password(mut self, password: String) -> Self {
         self.password = Some(password);
         self
     }
 
+    /// Join a room with only that much history.
     pub fn with_history(mut self, history: History) -> Self {
         self.history = Some(history);
         self