touchup documentation

4 files changed, 41 insertions, 43 deletions

diff --git a/source/QXmppClient.h b/source/QXmppClient.h
index 2ad0b6e0..74d075a4 100644
--- a/source/QXmppClient.h
+++ b/source/QXmppClient.h
@@ -21,21 +21,6 @@
  *
  */
 
-/// \class QXmppClient
-/// \brief The QXmppClient is the main class for using QXmpp.
-///
-/// It provides the user all the required functionality to connect to the server
-/// and perform operations afterwards.
-///
-/// This class will provide the handle/reference to QXmppRoster (roster management),
-///  QXmppVCardManager (vCard manager) and QXmppReconnectionManager (reconnection
-/// mechanism).
-///
-/// By default, a reconnection mechanism exists, which makes sure of reconnecting
-/// to the server on dissconnections due to an error. User can have a custom
-/// reconnection mechanism as well.
-///
-
 #ifndef QXMPPCLIENT_H
 #define QXMPPCLIENT_H
 
@@ -64,6 +49,20 @@ class QXmppDiscoveryIq;
 class QXmppTransferManager;
 class QXmppVersionIq;
 
+/// \brief The QXmppClient class is the main class for using QXmpp.
+///
+/// It provides the user all the required functionality to connect to the server
+/// and perform operations afterwards.
+///
+/// This class will provide the handle/reference to QXmppRoster (roster management),
+/// QXmppVCardManager (vCard manager), QXmppReconnectionManager (reconnection
+/// mechanism) and QXmppTransferManager (file transfers).
+///
+/// By default, a reconnection mechanism exists, which makes sure of reconnecting
+/// to the server on disconnections due to an error. User can have a custom
+/// reconnection mechanism as well.
+///
+
 class QXmppClient : public QObject
 {
     Q_OBJECT
diff --git a/source/QXmppConfiguration.h b/source/QXmppConfiguration.h
index dec55822..ba9e37e2 100644
--- a/source/QXmppConfiguration.h
+++ b/source/QXmppConfiguration.h
@@ -22,22 +22,23 @@
  */
 
 
-/// \class QXmppConfiguration
-///
-/// \brief The QXmppConfiguration is a configuration class. Its object can be passed
-/// to the QXmppClient for connecting the an XMPP server.
-///
-/// It is a container of all the settings, configuration required for connecting to
-/// an XMPP server. E.g. server name, username, port, type of authentication mechanism,
-/// type of security used by stream (encryption) etc.
-///
-
 #ifndef QXMPPCONFIGURATION_H
 #define QXMPPCONFIGURATION_H
 
 #include <QString>
 #include <QNetworkProxy>
 
+/// \brief The QXmppConfiguration class holds configuration options.
+///
+/// It can be passed to QXmppClient to specify the options when connecting to
+/// an XMPP server.
+///
+/// It is a container of all the settings, configuration required for
+/// connecting to an XMPP server. E.g. server name, username, port, type
+/// of authentication mechanism, type of security used by stream (encryption),
+/// etc..
+///
+
 class QXmppConfiguration
 {
 public:
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
diff --git a/source/QXmppTransferManager.h b/source/QXmppTransferManager.h
index 6e50830c..f0e74af2 100644
--- a/source/QXmppTransferManager.h
+++ b/source/QXmppTransferManager.h
@@ -43,7 +43,7 @@ class QXmppSocksClient;
 class QXmppSocksServer;
 class QXmppStreamInitiationIq;
 
-/// The QXmppTransferJob class represent a single file transfer job.
+/// \brief The QXmppTransferJob class represents a single file transfer job.
 ///
 /// \sa QXmppTransferManager
 ///
@@ -165,8 +165,8 @@ private:
     friend class QXmppTransferManager;
 };
 
-/// The QXmppTransferManager class provides support for sending and receiving
-/// files.
+/// \brief The QXmppTransferManager class provides support for sending and
+/// receiving files.
 ///
 /// Stream initiation is performed as described in XEP-0095: Stream Initiation
 /// and XEP-0096: SI File Transfer. The actual file transfer is then performed