From 7612c53f9af82c7cba7548c21e9ce519c838a13f Mon Sep 17 00:00:00 2001
From: Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
Date: Thu, 20 Jul 2017 23:47:21 +0100
Subject: [PATCH] attention, chatstates, eme, ping: Add a docstring on the
 structs.

---
 src/attention.rs  |  1 +
 src/chatstates.rs | 11 +++++++++++
 src/eme.rs        |  5 +++++
 src/ping.rs       |  1 +
 4 files changed, 18 insertions(+)

diff --git a/src/attention.rs b/src/attention.rs
index e394785f76737b0b85b646be69760477be5f64a5..7d0b1f24ff3835472c464c9915973a1629fd2780 100644
--- a/src/attention.rs
+++ b/src/attention.rs
@@ -12,6 +12,7 @@ use error::Error;
 
 use ns;
 
+/// Structure representing an `<attention xmlns='urn:xmpp:attention:0'/>` element.
 #[derive(Debug, Clone)]
 pub struct Attention;
 
diff --git a/src/chatstates.rs b/src/chatstates.rs
index a5af910c6dca44762f9305f30f15ed5723e653b1..4093edbd29c805a39dbe65731dbf365ff3341413 100644
--- a/src/chatstates.rs
+++ b/src/chatstates.rs
@@ -12,12 +12,23 @@ use error::Error;
 
 use ns;
 
+/// Enum representing chatstate elements part of the
+/// `http://jabber.org/protocol/chatstates` namespace.
 #[derive(Debug, Clone)]
 pub enum ChatState {
+    /// `<active xmlns='http://jabber.org/protocol/chatstates'/>`
     Active,
+
+    /// `<composing xmlns='http://jabber.org/protocol/chatstates'/>`
     Composing,
+
+    /// `<gone xmlns='http://jabber.org/protocol/chatstates'/>`
     Gone,
+
+    /// `<inactive xmlns='http://jabber.org/protocol/chatstates'/>`
     Inactive,
+
+    /// `<paused xmlns='http://jabber.org/protocol/chatstates'/>`
     Paused,
 }
 
diff --git a/src/eme.rs b/src/eme.rs
index ba07f95cef5613123e180f88bd1148cc93970510..288431b9c975b95ebc180c7bfeb74c43da63d72a 100644
--- a/src/eme.rs
+++ b/src/eme.rs
@@ -12,9 +12,14 @@ use error::Error;
 
 use ns;
 
+/// Structure representing an `<encryption xmlns='urn:xmpp:eme:0'/>` element.
 #[derive(Debug, Clone)]
 pub struct ExplicitMessageEncryption {
+    /// Namespace of the encryption scheme used.
     pub namespace: String,
+
+    /// User-friendly name for the encryption scheme, should be `None` for OTR,
+    /// legacy OpenPGP and OX.
     pub name: Option<String>,
 }
 
diff --git a/src/ping.rs b/src/ping.rs
index df8b193997ad413ad71960289d6a1c26075deb69..c97fa5026ac5595ac3db83332afa492746a3ea3b 100644
--- a/src/ping.rs
+++ b/src/ping.rs
@@ -13,6 +13,7 @@ use error::Error;
 
 use ns;
 
+/// Structure representing a `<ping xmlns='urn:xmpp:ping'/>` element.
 #[derive(Debug, Clone)]
 pub struct Ping;