From 998cf2b6c2dea966d970a7fef0a43926a8b37c9c Mon Sep 17 00:00:00 2001
From: Melvin Keskin <melvo@olomono.de>
Date: Mon, 21 Nov 2022 15:07:56 +0100
Subject: Improve and update OMEMO documentation

* OmemoManager: Use new CarbonManagerV2 and addNewExtension() for class documentation
* OmemoManager: Remove unneeded Doxygen references for method documentation
* doc: index: Add OmemoManager
---
 src/omemo/QXmppOmemoManager.cpp | 26 +++++---------------------
 1 file changed, 5 insertions(+), 21 deletions(-)

(limited to 'src/omemo/QXmppOmemoManager.cpp')

diff --git a/src/omemo/QXmppOmemoManager.cpp b/src/omemo/QXmppOmemoManager.cpp
index 8b1e532b..938df22a 100644
--- a/src/omemo/QXmppOmemoManager.cpp
+++ b/src/omemo/QXmppOmemoManager.cpp
@@ -249,14 +249,12 @@ void QXmppOmemoDevice::setTrustLevel(TrustLevel trustLevel)
 ///
 /// A trust manager using its storage must be added to the client:
 /// \code
-/// QXmppTrustManager *trustManager = new QXmppAtmManager(trustStorage);
-/// client->addExtension(trustManager);
+/// client->addNewExtension<QXmppAtmManager>(trustStorage);
 /// \endcode
 ///
 /// Afterwards, the OMEMO manager using its storage must be added to the client:
 /// \code
-/// QXmppOmemoManager *manager = new QXmppOmemoManager(omemoStorage);
-/// client->addExtension(manager);
+/// auto *manager = client->addNewExtension<QXmppOmemoManager>(omemoStorage);
 /// \endcode
 ///
 /// You can set a security policy used by OMEMO.
@@ -268,17 +266,11 @@ void QXmppOmemoDevice::setTrustLevel(TrustLevel trustLevel)
 ///
 /// \xep{0280, Message Carbons} should be used for delivering messages to all endpoints of a user:
 /// \code
-/// QXmppCarbonManager *carbonManager = new QXmppCarbonManager;
-/// client->addExtension(carbonManager);
-/// connect(client, &QXmppClient::connected, this, [=]() {
-///     carbonManager->setCarbonsEnabled(true);
-/// });
-/// connect(carbonManager, &QXmppCarbonManager::messageSent, manager,
-///     &QXmppOmemoManager::handleMessage);
-/// connect(carbonManager, &QXmppCarbonManager::messageReceived, manager,
-///     &QXmppOmemoManager::handleMessage);
+/// client->addNewExtension<QXmppCarbonManagerV2>();
 /// \endcode
 ///
+/// The old QXmppCarbonManager cannot be used with OMEMO.
+///
 /// The OMEMO data must be loaded before connecting to the server:
 /// \code
 ///     manager->load();
@@ -939,8 +931,6 @@ QFuture<bool> Manager::resetAll()
     return d->resetAll();
 }
 
-///
-/// \fn QXmppOmemoManager::setSecurityPolicy(QXmpp::TrustSecurityPolicy securityPolicy)
 ///
 /// Sets the security policy used by this E2EE extension.
 ///
@@ -951,8 +941,6 @@ QFuture<void> Manager::setSecurityPolicy(QXmpp::TrustSecurityPolicy securityPoli
     return d->trustManager->setSecurityPolicy(ns_omemo_2, securityPolicy);
 }
 
-///
-/// \fn QXmppOmemoManager::securityPolicy()
 ///
 /// Returns the security policy used by this E2EE extension.
 ///
@@ -963,8 +951,6 @@ QFuture<QXmpp::TrustSecurityPolicy> Manager::securityPolicy()
     return d->trustManager->securityPolicy(ns_omemo_2);
 }
 
-///
-/// \fn QXmppOmemoManager::setTrustLevel(const QMultiHash<QString, QByteArray> &keyIds, QXmpp::TrustLevel trustLevel)
 ///
 /// Sets the trust level of keys.
 ///
@@ -978,8 +964,6 @@ QFuture<void> Manager::setTrustLevel(const QMultiHash<QString, QByteArray> &keyI
     return d->trustManager->setTrustLevel(ns_omemo_2, keyIds, trustLevel);
 }
 
-///
-/// \fn QXmppOmemoManager::trustLevel(const QString &keyOwnerJid, const QByteArray &keyId)
 ///
 /// Returns the trust level of a key.
 ///
-- 
cgit v1.2.3