aboutsummaryrefslogtreecommitdiff
path: root/src/QXmppArchiveManager.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/QXmppArchiveManager.h')
-rw-r--r--src/QXmppArchiveManager.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/QXmppArchiveManager.h b/src/QXmppArchiveManager.h
index 10008000..073bf0b6 100644
--- a/src/QXmppArchiveManager.h
+++ b/src/QXmppArchiveManager.h
@@ -36,6 +36,14 @@ class QXmppArchivePrefIq;
/// \brief The QXmppArchiveManager class makes it possible to access message
/// archives as defined by XEP-0136: Message Archiving.
///
+/// To make use of this manager, you need to instantiate it and load it into
+/// the QXmppClient instance as follows:
+///
+/// \code
+/// QXmppArchiveManager *manager = new QXmppArchiveManager(client);
+/// client->addExtension(manager);
+/// \endcode
+///
/// \note Few servers support message archiving. Check if the server in use supports
/// this XEP.
///