aboutsummaryrefslogtreecommitdiff
path: root/src/client/QXmppRosterManager.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/QXmppRosterManager.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/QXmppRosterManager.h')
-rw-r--r--src/client/QXmppRosterManager.h31
1 files changed, 17 insertions, 14 deletions
diff --git a/src/client/QXmppRosterManager.h b/src/client/QXmppRosterManager.h
index 869b6b42..6b050197 100644
--- a/src/client/QXmppRosterManager.h
+++ b/src/client/QXmppRosterManager.h
@@ -35,29 +35,32 @@
class QXmppRosterManagerPrivate;
-/// \brief The QXmppRosterManager class provides access to a connected client's roster.
+/// \brief The QXmppRosterManager class provides access to a connected client's
+/// roster.
///
/// \note It's object should not be created using it's constructor. Instead
-/// QXmppClient::rosterManager() should be used to get the reference of instantiated
-/// object this class.
+/// \c QXmppClient::findExtension<QXmppRosterManager>() should be used to get
+/// the instantiated object of this class.
///
-/// It stores all the Roster and Presence details of all the roster entries (that
-/// is all the bareJids) in the client's friend's list. It provides the
+/// It stores all the Roster and Presence details of all the roster entries
+/// (that is all the bareJids) in the client's friend's list. It provides the
/// functionality to get all the bareJids in the client's roster and Roster and
/// Presence details of the same.
///
-/// After the successful xmpp connection that after the signal QXmppClient::connected()
-/// is emitted QXmpp requests for getting the roster. Once QXmpp receives the roster
-/// the signal QXmppRosterManager::rosterReceived() is emitted and after that user can
-/// use the functions of this class to get roster entries.
+/// After the QXmpp connected successfully to the XMPP server the signal
+/// \c QXmppClient::connected() is emitted and the roster is requested from the
+/// server. Once QXmpp receives the roster the signal
+/// \c QXmppRosterManager::rosterReceived() is emitted and after that the
+/// methods of this class can be used to get the roster entries.
///
-/// Function QXmppRosterManager::isRosterReceived() tells whether the roster has been
-/// received or not.
+/// \c QXmppRosterManager::isRosterReceived() can be used to find out whether
+/// the roster has been received yet.
///
-/// The itemAdded(), itemChanged() and itemRemoved() signals are emitted whenever roster
-/// entries are added, changed or removed.
+/// The \c itemAdded(), \c itemChanged() and \c itemRemoved() signals are
+/// emitted whenever roster entries are added, changed or removed.
///
-/// The presenceChanged() signal is emitted whenever the presence for a roster item changes.
+/// The \c presenceChanged() signal is emitted whenever the presence for a
+/// roster item changes.
///
/// \ingroup Managers