xmppftw/xmpp-rs
Watch
1
0
Fork
You've already forked xmpp-rs
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix last cargo doc warnings

Browse source 
Signed-off-by: Maxime “pep” Buquet <pep@bouah.net>
This commit is contained in:
xmppftw xmppftw 2024-01-27 18:18:58 +01:00 • committed by pep
commit 9d5019ecdd
5 changed files with 10 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

19
xmpp/src/agent.rs
View file

@ -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,

2
xmpp/src/delay.rs
View file

@ -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![];

7
xmpp/src/muc/room.rs
View file

@ -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
///