From 4f357f773b1078f1ef3877692a091ec1dbbe16a1 Mon Sep 17 00:00:00 2001
From: lumi <lumi@pew.im>
Date: Sat, 25 Feb 2017 15:50:26 +0100
Subject: [PATCH] add some documentation to src/sasl/mod.rs

---
 src/sasl/mod.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/sasl/mod.rs b/src/sasl/mod.rs
index 25d4d3a..1c489f5 100644
--- a/src/sasl/mod.rs
+++ b/src/sasl/mod.rs
@@ -1,13 +1,17 @@
 //! Provides the `SaslMechanism` trait and some implementations.
 
+/// A struct containing SASL credentials.
 pub struct SaslCredentials {
     pub username: String,
     pub secret: SaslSecret,
     pub channel_binding: Option<Vec<u8>>,
 }
 
+/// Represents a SASL secret, like a password.
 pub enum SaslSecret {
+    /// No extra data needed.
     None,
+    /// Password required.
     Password(String),
 }