message, presence, iq: Improve documentation.

Emmanuel Gil Peyrot created 8 years ago

Change summary

src/iq.rs       |  1 +
src/lib.rs      | 12 ++++++++++--
src/message.rs  |  1 +
src/presence.rs |  1 +
4 files changed, 13 insertions(+), 2 deletions(-)

Detailed changes

src/iq.rs

@@ -190,6 +190,7 @@ impl<'a> IntoAttributeValue for &'a IqType {
     }
 }
 
+/// The main structure representing the `<iq/>` stanza.
 #[derive(Debug, Clone)]
 pub struct Iq {
     pub from: Option<Jid>,

src/lib.rs

@@ -58,7 +58,11 @@ macro_rules! generate_attribute {
     ($elem:ident, $name:tt, {$($a:ident => $b:tt),+}) => (
         #[derive(Debug, Clone, PartialEq)]
         pub enum $elem {
-            $($a),+
+            $(
+                #[doc=$b]
+                #[doc="value for this attribute."]
+                $a
+            ),+
         }
         impl FromStr for $elem {
             type Err = Error;
@@ -80,7 +84,11 @@ macro_rules! generate_attribute {
     ($elem:ident, $name:tt, {$($a:ident => $b:tt),+}, Default = $default:ident) => (
         #[derive(Debug, Clone, PartialEq)]
         pub enum $elem {
-            $($a),+
+            $(
+                #[doc=$b]
+                #[doc="value for this attribute."]
+                $a
+            ),+
         }
         impl FromStr for $elem {
             type Err = Error;

src/message.rs

@@ -115,6 +115,7 @@ type Body = String;
 type Subject = String;
 type Thread = String;
 
+/// The main structure representing the `<message/>` stanza.
 #[derive(Debug, Clone)]
 pub struct Message {
     pub from: Option<Jid>,

src/presence.rs

@@ -186,6 +186,7 @@ impl IntoAttributeValue for Type {
     }
 }
 
+/// The main structure representing the `<presence/>` stanza.
 #[derive(Debug, Clone)]
 pub struct Presence {
     pub from: Option<Jid>,