improve documentation

5 files changed, 37 insertions, 10 deletions

diff --git a/src/QXmppInvokable.cpp b/src/QXmppInvokable.cpp
index cc100b67..a059e356 100644
--- a/src/QXmppInvokable.cpp
+++ b/src/QXmppInvokable.cpp
@@ -29,16 +29,13 @@
 
 #include <qdebug.h>
 
-QXmppInvokable::QXmppInvokable( QObject *parent )
-    : QObject( parent )
-{
-
-}
+/// Constructs a QXmppInvokable with the specified \a parent.
+///
+/// \param parent
 
-
-QXmppInvokable::~QXmppInvokable()
+QXmppInvokable::QXmppInvokable(QObject *parent)
+    : QObject(parent)
 {
-
 }
 
 QVariant QXmppInvokable::dispatch( const QByteArray & method, const QList< QVariant > & args )
diff --git a/src/QXmppMessage.cpp b/src/QXmppMessage.cpp
index e05973df..47a07d5e 100644
--- a/src/QXmppMessage.cpp
+++ b/src/QXmppMessage.cpp
@@ -38,6 +38,13 @@ static const char* chat_states[] = {
     "paused",
 };
 
+/// Constructs a QXmppMessage.
+///
+/// \param from
+/// \param to
+/// \param body
+/// \param thread
+
 QXmppMessage::QXmppMessage(const QString& from, const QString& to, const 
                          QString& body, const QString& thread)
     : QXmppStanza(from, to),
diff --git a/src/QXmppMucIq.cpp b/src/QXmppMucIq.cpp
index f3f5d740..2dc348e3 100644
--- a/src/QXmppMucIq.cpp
+++ b/src/QXmppMucIq.cpp
@@ -77,11 +77,17 @@ void QXmppMucAdminIq::Item::setRole(const QString &role)
     m_role = role;
 }
 
+/// Returns the IQ's items.
+
 QList<QXmppMucAdminIq::Item> QXmppMucAdminIq::items() const
 {
     return m_items;
 }
 
+/// Sets the IQ's items.
+///
+/// \param items
+
 void QXmppMucAdminIq::setItems(const QList<QXmppMucAdminIq::Item> &items)
 {
     m_items = items;
@@ -127,11 +133,17 @@ void QXmppMucAdminIq::toXmlElementFromChild(QXmlStreamWriter *writer) const
     writer->writeEndElement();
 }
 
+/// Returns the IQ's data form.
+
 QXmppDataForm QXmppMucOwnerIq::form() const
 {
     return m_form;
 }
 
+/// Sets the IQ's data form.
+///
+/// \param form
+
 void QXmppMucOwnerIq::setForm(const QXmppDataForm &form)
 {
     m_form = form;
diff --git a/src/QXmppMucManager.cpp b/src/QXmppMucManager.cpp
index e82fedf1..32dd4078 100644
--- a/src/QXmppMucManager.cpp
+++ b/src/QXmppMucManager.cpp
@@ -30,6 +30,10 @@
 #include "QXmppMucManager.h"
 #include "QXmppUtils.h"
 
+/// Constructs a QXmppMucManager to interact with multi-user chat rooms.
+///
+/// \param client
+
 QXmppMucManager::QXmppMucManager(QXmppClient* client)
 {
     bool check = connect(client, SIGNAL(messageReceived(QXmppMessage)),
@@ -142,7 +146,6 @@ QMap<QString, QXmppPresence> QXmppMucManager::roomParticipants(const QString& ro
 /// \return true if the request was sent, false otherwise
 ///
 /// \sa roomConfigurationReceived()
-///
 
 bool QXmppMucManager::requestRoomConfiguration(const QString &roomJid)
 {
@@ -157,7 +160,6 @@ bool QXmppMucManager::requestRoomConfiguration(const QString &roomJid)
 /// \param form
 ///
 /// \return true if the request was sent, false otherwise
-///
 
 bool QXmppMucManager::setRoomConfiguration(const QString &roomJid, const QXmppDataForm &form)
 {
@@ -168,6 +170,12 @@ bool QXmppMucManager::setRoomConfiguration(const QString &roomJid, const QXmppDa
     return client()->sendPacket(iqPacket);
 }
 
+/// Request the room's permissions.
+///
+/// \param roomJid
+///
+/// \return true if the request was sent, false otherwise
+
 bool QXmppMucManager::requestRoomPermissions(const QString &roomJid)
 {
     QStringList affiliations;
diff --git a/src/QXmppMucManager.h b/src/QXmppMucManager.h
index 3ca114db..2f57d168 100644
--- a/src/QXmppMucManager.h
+++ b/src/QXmppMucManager.h
@@ -77,6 +77,9 @@ signals:
     /// This signal is emitted when the permissions for a chat room are received.
     void roomPermissionsReceived(const QString &roomJid, const QList<QXmppMucAdminIq::Item> &permissions);
 
+    /// This signal is emitted when a room participant's presence changed.
+    ///
+    /// \sa roomParticipants()
     void roomParticipantChanged(const QString &roomJid, const QString &nickName);
 
 private slots: