aboutsummaryrefslogtreecommitdiff
path: root/src/client/QXmppClient.h
diff options
context:
space:
mode:
authorLinus Jahn <lnj@kaidan.im>2019-10-21 17:01:03 +0200
committerLNJ <lnj@kaidan.im>2019-10-23 12:13:18 +0200
commitdfec49b06fc305cc55631e5473b9ba19c729cd03 (patch)
tree268083483bec5f41ce9b4dab1f0a9ece3f5258ed /src/client/QXmppClient.h
parent91157d28b88ef3bab80100cd816c643809944a27 (diff)
downloadqxmpp-dfec49b06fc305cc55631e5473b9ba19c729cd03.tar.gz
Port away from deprecated client extension getters of the QXmppClient
This replaces the deprecated getters in the examples and in the documentation.
Diffstat (limited to 'src/client/QXmppClient.h')
-rw-r--r--src/client/QXmppClient.h22
1 files changed, 11 insertions, 11 deletions
diff --git a/src/client/QXmppClient.h b/src/client/QXmppClient.h
index 5f765602..d3726334 100644
--- a/src/client/QXmppClient.h
+++ b/src/client/QXmppClient.h
@@ -64,9 +64,9 @@ class QXmppVersionManager;
/// QXmppConfiguration::setAutoReconnectionEnabled().
///
/// Not all the managers or extensions have been enabled by default. One can
-/// enable/disable the managers using the functions addExtension() and
-/// removeExtension(). findExtension() can be used to find reference/pointer to
-/// particular instansiated and enabled manager.
+/// enable/disable the managers using the functions \c addExtension() and
+/// \c removeExtension(). \c findExtension() can be used to find reference/
+/// pointer to particular instansiated and enabled manager.
///
/// List of managers enabled by default:
/// - QXmppRosterManager
@@ -168,8 +168,8 @@ public:
signals:
- /// This signal is emitted when the client connects successfully to the XMPP
- /// server i.e. when a successful XMPP connection is established.
+ /// This signal is emitted when the client connects successfully to the
+ /// XMPP server i.e. when a successful XMPP connection is established.
/// XMPP Connection involves following sequential steps:
/// - TCP socket connection
/// - Client sends start stream
@@ -182,15 +182,15 @@ signals:
/// After all these steps a successful XMPP connection is established and
/// connected() signal is emitted.
///
- /// After the connected() signal is emitted QXmpp will send the roster request
- /// to the server. On receiving the roster, QXmpp will emit
- /// QXmppRosterManager::rosterReceived(). After this signal, QXmppRosterManager object gets
- /// populated and you can use rosterManager() to get the handle of QXmppRosterManager object.
- ///
+ /// After the connected() signal is emitted QXmpp will send the roster
+ /// request to the server. On receiving the roster, QXmpp will emit
+ /// QXmppRosterManager::rosterReceived(). After this signal,
+ /// QXmppRosterManager object gets populated and you can use
+ /// \c findExtension<QXmppRosterManager>() to get the handle of
+ /// QXmppRosterManager object.
void connected();
/// This signal is emitted when the XMPP connection disconnects.
- ///
void disconnected();
/// This signal is emitted when the XMPP connection encounters any error.