From 7a556084334a96da4aa1ce0b45b82385cc451b7c Mon Sep 17 00:00:00 2001 From: xmppftw Date: Sat, 16 Dec 2023 13:03:22 +0100 Subject: [PATCH] Document bookmarks2 module --- parsers/src/bookmarks2.rs | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/parsers/src/bookmarks2.rs b/parsers/src/bookmarks2.rs index 16ca307..94551bc 100644 --- a/parsers/src/bookmarks2.rs +++ b/parsers/src/bookmarks2.rs @@ -3,6 +3,17 @@ // This Source Code Form is subject to the terms of the Mozilla Public // License, v. 2.0. If a copy of the MPL was not distributed with this // file, You can obtain one at http://mozilla.org/MPL/2.0/. + +//! +//! Chatroom bookmarks from [XEP-0402](https://xmpp.org/extensions/xep-0402.html) for newer servers +//! which advertise `urn:xmpp:bookmarks:1#compat` on the user's BareJID in a disco info request. +//! On legacy non-compliant servers, use the [`crate::bookmarks`] module instead. +//! +//! See [ModernXMPP docs](https://docs.modernxmpp.org/client/groupchat/#bookmarks) on how to handle all historic +//! and newer specifications for your clients. +//! +//! This module exposes the [`Autojoin`][crate::bookmarks2::Autojoin] boolean flag, the [`Conference`][crate::bookmarks2::Conference] chatroom element, and the [BOOKMARKS2][crate::ns::BOOKMARKS2] XML namespace. + use crate::ns; use crate::util::error::Error; use crate::Element;