Fix last cargo doc warnings

xmpp ftw created 

Signed-off-by: Maxime “pep” Buquet <pep@bouah.net>

Change summary

parsers/src/vcard.rs        |  4 ++--
parsers/src/vcard_update.rs |  3 +--
xmpp/src/agent.rs           | 19 ++++---------------
xmpp/src/delay.rs           |  2 +-
xmpp/src/muc/room.rs        |  7 ++-----
5 files changed, 10 insertions(+), 25 deletions(-)

Detailed changes

parsers/src/vcard.rs 🔗 

@@ -7,7 +7,7 @@
 //! This module implements vCard, for the purpose of vCard-based avatars as defined in
 //! [XEP-0054](https://xmpp.org/extensions/xep-0054.html).
 //!
-//! Only the <PHOTO> element is supported as a member of this legacy vCard. For more modern and complete
+//! Only the `<PHOTO>` element is supported as a member of this legacy vCard. For more modern and complete
 //! user profile management, see [XEP-0292](https://xmpp.org/extensions/xep-0292.html): vCard4 Over XMPP.
 //!
 //! For vCard updates defined in [XEP-0153](https://xmpp.org/extensions/xep-0153.html),
@@ -48,7 +48,7 @@ generate_element!(
     )
 );
 
-/// A <vCard> element; only the <PHOTO> element is supported for this legacy vCard ; the rest is ignored.
+/// A `<vCard>` element; only the `<PHOTO>` element is supported for this legacy vCard ; the rest is ignored.
 pub struct VCard {
     /// A photo element.
     pub photo: Option<Photo>,

parsers/src/vcard_update.rs 🔗 

@@ -7,8 +7,7 @@
 //! This module implements vCard avatar updates defined in
 //! [XEP-0153](https://xmpp.org/extensions/xep-0153.html).
 //!
-//! Specifically, as it appears in <presence> stanzas, as shown in this example:
-//! https://xmpp.org/extensions/xep-0153.html#example-3
+//! Specifically, as it appears in `<presence>` stanzas, as shown in [XEP-0153 example 3](https://xmpp.org/extensions/xep-0153.html#example-3).
 //!
 //! For [XEP-0054](https://xmpp.org/extensions/xep-0054.html) vCard support,
 //! see [`vcard`][crate::vcard] module.

xmpp/src/agent.rs 🔗 

@@ -39,27 +39,16 @@ impl<C: ServerConnector> Agent<C> {
         muc::room::join_room(self, room, nick, password, lang, status).await
     }
 
-    /// Send a "leave room" request to the server (specifically, an "unavailable" presence stanza).
+    /// Request to leave a chatroom.
     ///
-    /// The returned future will resolve when the request has been sent,
-    /// not when the room has actually been left.
-    ///
-    /// If successful, a `RoomLeft` event should be received later as a confirmation.
-    ///
-    /// See: https://xmpp.org/extensions/xep-0045.html#exit
-    ///
-    /// Note that this method does NOT remove the room from the auto-join list; the latter
-    /// is more a list of bookmarks that the account knows about and that have a flag set
-    /// to indicate that they should be joined automatically after connecting (see the JoinRoom event).
-    ///
-    /// Regarding the latter, see the these minutes about auto-join behavior:
-    /// https://docs.modernxmpp.org/meetings/2019-01-brussels/#bookmarks
+    /// If successful, an [Event::RoomLeft] event will be produced. This method does not remove the room
+    /// from bookmarks nor remove the autojoin flag. See [muc::room::leave_room] for more information.
     ///
     /// # Arguments
     ///
     /// * `room_jid`: The JID of the room to leave.
     /// * `nickname`: The nickname to use in the room.
-    /// * `lang`: The language of the status message.
+    /// * `lang`: The language of the status message (empty string when unknown).
     /// * `status`: The status message to send.
     pub async fn leave_room(
         &mut self,

xmpp/src/delay.rs 🔗 

@@ -38,7 +38,7 @@ impl StanzaTimeInfo {
 /// Parsing a [`Message`], store the current time it was processed, as well [XEP-0203](https://xmpp.org/extensions/xep-0203.html#protocol)
 /// [`Delay`] contained in the message's payloads.
 ///
-/// Specifically, this method will look for any <delay/> element in the message's payloads. If they were found,
+/// Specifically, this method will look for any `<delay/>` element in the message's payloads. If they were found,
 /// they will be added to the [`StanzaTimeInfo`] result.
 pub fn message_time_info(message: &Message) -> StanzaTimeInfo {
     let mut delays = vec![];

xmpp/src/muc/room.rs 🔗 

@@ -41,16 +41,13 @@ pub async fn join_room<C: ServerConnector>(
 /// The returned future will resolve when the request has been sent,
 /// not when the room has actually been left.
 ///
-/// If successful, a `RoomLeft` event should be received later as a confirmation.
-///
-/// See: https://xmpp.org/extensions/xep-0045.html#exit
+/// If successful, a `RoomLeft` event should be received later as a confirmation. See [XEP-0045](https://xmpp.org/extensions/xep-0045.html#exit).
 ///
 /// Note that this method does NOT remove the room from the auto-join list; the latter
 /// is more a list of bookmarks that the account knows about and that have a flag set
 /// to indicate that they should be joined automatically after connecting (see the JoinRoom event).
 ///
-/// Regarding the latter, see the these minutes about auto-join behavior:
-/// https://docs.modernxmpp.org/meetings/2019-01-brussels/#bookmarks
+/// Regarding the latter, see the these [ModernXMPP minutes about auto-join behavior](https://docs.modernxmpp.org/meetings/2019-01-brussels/#bookmarks).
 ///
 /// # Arguments
 ///