aboutsummaryrefslogtreecommitdiff
path: root/source/QXmppRoster.h
diff options
context:
space:
mode:
authorJeremy Lainé <jeremy.laine@m4x.org>2010-03-06 14:44:35 +0000
committerJeremy Lainé <jeremy.laine@m4x.org>2010-03-06 14:44:35 +0000
commitb2f5d20005d01eeb19d7e694038035873625ecc3 (patch)
treef6aea608a985ec37288edc38212c0570a60bf2e9 /source/QXmppRoster.h
parentac1831936f7858d7f2197ef11dff226ce08d5bb1 (diff)
downloadqxmpp-b2f5d20005d01eeb19d7e694038035873625ecc3.tar.gz
touchup documentation
Diffstat (limited to 'source/QXmppRoster.h')
-rw-r--r--source/QXmppRoster.h28
1 files changed, 13 insertions, 15 deletions
diff --git a/source/QXmppRoster.h b/source/QXmppRoster.h
index 778f7f5b..727eba85 100644
--- a/source/QXmppRoster.h
+++ b/source/QXmppRoster.h
@@ -21,9 +21,20 @@
*
*/
+#ifndef QXMPPROSTER_H
+#define QXMPPROSTER_H
+
+#include <QObject>
+#include <QMap>
+#include <QSet>
+#include <QStringList>
-/// \class QXmppRoster
-/// \brief Class for handling the roster of the connected client.
+#include "QXmppClient.h"
+
+class QXmppRosterIq;
+class QXmppPresence;
+
+/// \brief The QXmppRoster class provides access to a connected client's roster.
///
/// \note It's object should not be created using it's constructor. Instead
/// QXmppClient::getRoster() should be used to get the reference of instantiated
@@ -46,19 +57,6 @@
/// or roster changes respectively.
///
-#ifndef QXMPPROSTER_H
-#define QXMPPROSTER_H
-
-#include <QObject>
-#include <QMap>
-#include <QSet>
-#include <QStringList>
-
-#include "QXmppClient.h"
-
-class QXmppRosterIq;
-class QXmppPresence;
-
class QXmppRoster : public QObject
{
Q_OBJECT