improve code documentation

9 files changed, 29 insertions, 12 deletions

diff --git a/source/QXmppArchiveManager.h b/source/QXmppArchiveManager.h
index c4ec0ada..0acbf83a 100644
--- a/source/QXmppArchiveManager.h
+++ b/source/QXmppArchiveManager.h
@@ -33,7 +33,11 @@ class QXmppArchiveListIq;
 class QXmppArchivePrefIq;
 class QXmppStream;
 
-/// XEP-0136: Message Archiving
+/// \brief The QXmppArchiveManager class makes it possible to access message
+/// archives as defined by XEP-0136: Message Archiving.
+///
+/// \ingroup Managers
+
 class QXmppArchiveManager : public QObject
 {
     Q_OBJECT
diff --git a/source/QXmppCallManager.h b/source/QXmppCallManager.h
index ea397ab5..7885b908 100644
--- a/source/QXmppCallManager.h
+++ b/source/QXmppCallManager.h
@@ -42,7 +42,7 @@ class QXmppStunSocket;
 /// It acts as a QIODevice so that you can read / write audio samples, for
 /// instance using a QAudioInput and/or QAudioOutput.
 ///
-/// \note: THIS API IS NOT FINALIZED YET
+/// \note THIS API IS NOT FINALIZED YET
 
 class QXmppCall : public QIODevice
 {
@@ -170,7 +170,8 @@ private:
 /// (RFC 5245) and data is transfered using Real Time Protocol (RFC 3550)
 /// packets.
 ///
-/// \note: THIS API IS NOT FINALIZED YET
+/// \ingroup Managers
+/// \note THIS API IS NOT FINALIZED YET
 
 class QXmppCallManager : public QObject
 {
diff --git a/source/QXmppClient.h b/source/QXmppClient.h
index de1683ae..25bdf6b5 100644
--- a/source/QXmppClient.h
+++ b/source/QXmppClient.h
@@ -52,6 +52,8 @@ class QXmppVCardManager;
 class QXmppTransferManager;
 class QXmppCallManager;
 
+/// \defgroup Managers
+
 /// \brief The QXmppClient class is the main class for using QXmpp.
 ///
 /// It provides the user all the required functionality to connect to the server
diff --git a/source/QXmppIq.cpp b/source/QXmppIq.cpp
index c4215d5f..f0ba8e6b 100644
--- a/source/QXmppIq.cpp
+++ b/source/QXmppIq.cpp
@@ -34,16 +34,18 @@ QXmppIq::QXmppIq(QXmppIq::Type type)
     generateAndSetNextId();
 }
 
-QXmppIq::~QXmppIq()
-{
-
-}
+/// Returns the IQ's type.
+///
 
 QXmppIq::Type QXmppIq::type() const
 {
     return m_type;
 }
 
+/// Sets the IQ's type.
+///
+/// \param type
+
 void QXmppIq::setType(QXmppIq::Type type)
 {
     m_type = type;
diff --git a/source/QXmppIq.h b/source/QXmppIq.h
index d38b5da3..f0140b54 100644
--- a/source/QXmppIq.h
+++ b/source/QXmppIq.h
@@ -33,7 +33,7 @@
 // for an explanation.
 #include <QXmlStreamWriter>
 
-/// \brief The QXmppIq packet is the base class for all IQs.
+/// \brief The QXmppIq class is the base class for all IQs.
 ///
 /// \ingroup Stanzas
 
@@ -50,22 +50,21 @@ public:
     };
 
     QXmppIq(QXmppIq::Type type = QXmppIq::Get);
-    ~QXmppIq();
 
     QXmppIq::Type type() const;
     void setType(QXmppIq::Type);
 
+    /// \cond
     void parse(const QDomElement &element);
     void toXml(QXmlStreamWriter *writer) const;
 
     // deprecated accessors, use the form without "get" instead
-    /// \cond
     QXmppIq::Type Q_DECL_DEPRECATED getType() const;
-    /// \endcond
 
 protected:
     virtual void parseElementFromChild(const QDomElement &element);
     virtual void toXmlElementFromChild(QXmlStreamWriter *writer) const;
+    /// \endcond
 
 private:
     QString getTypeStr() const;
diff --git a/source/QXmppMucManager.h b/source/QXmppMucManager.h
index a2d0fd44..68f9ace9 100644
--- a/source/QXmppMucManager.h
+++ b/source/QXmppMucManager.h
@@ -37,6 +37,7 @@ class QXmppStream;
 /// \brief The QXmppMucManager class makes it possible to interact with
 /// multi-user chat rooms as defined by XEP-0045: Multi-User Chat.
 ///
+/// \ingroup Managers
 
 class QXmppMucManager : public QObject
 {
diff --git a/source/QXmppRoster.h b/source/QXmppRoster.h
index d6d4f1a5..48ae28d4 100644
--- a/source/QXmppRoster.h
+++ b/source/QXmppRoster.h
@@ -58,6 +58,7 @@ class QXmppStream;
 /// Signals presenceChanged() or rosterChanged() are emitted whenever presence
 /// or roster changes respectively.
 ///
+/// \ingroup Managers
 
 class QXmppRoster : public QObject
 {
diff --git a/source/QXmppTransferManager.h b/source/QXmppTransferManager.h
index e248ed1b..931511e5 100644
--- a/source/QXmppTransferManager.h
+++ b/source/QXmppTransferManager.h
@@ -205,7 +205,9 @@ private:
 /// Stream initiation is performed as described in XEP-0095: Stream Initiation
 /// and XEP-0096: SI File Transfer. The actual file transfer is then performed
 /// using either XEP-0065: SOCKS5 Bytestreams or XEP-0047: In-Band Bytestreams.
-/// 
+///
+/// \ingroup Managers
+ 
 class QXmppTransferManager : public QObject
 {
     Q_OBJECT
diff --git a/source/QXmppVCardManager.h b/source/QXmppVCardManager.h
index 8ec078ee..6b70f1ab 100644
--- a/source/QXmppVCardManager.h
+++ b/source/QXmppVCardManager.h
@@ -31,6 +31,11 @@
 
 class QXmppStream;
 
+/// \brief The QXmppVCardManager class makes it possible to interact
+/// with XMPP vCards.
+///
+/// \ingroup Managers
+
 class QXmppVCardManager : public QObject
 {
     Q_OBJECT