improve code documentation

2 files changed, 17 insertions, 9 deletions

diff --git a/src/QXmppMucManager.cpp b/src/QXmppMucManager.cpp
index d6b71592..e4aedc43 100644
--- a/src/QXmppMucManager.cpp
+++ b/src/QXmppMucManager.cpp
@@ -186,6 +186,8 @@ QString QXmppMucRoom::jid() const
 }
 
 /// Joins the chat room.
+///
+/// \return true if the request was sent, false otherwise
 
 bool QXmppMucRoom::join()
 {
@@ -211,6 +213,8 @@ bool QXmppMucRoom::join()
 }
 
 /// Leaves the chat room.
+///
+/// \return true if the request was sent, false otherwise
 
 bool QXmppMucRoom::leave()
 {
@@ -231,6 +235,8 @@ QString QXmppMucRoom::nickName() const
 ///
 /// \param jid
 /// \param reason
+///
+/// \return true if the request was sent, false otherwise
 
 bool QXmppMucRoom::sendInvitation(const QString &jid, const QString &reason)
 {
@@ -248,6 +254,8 @@ bool QXmppMucRoom::sendInvitation(const QString &jid, const QString &reason)
 }
 
 /// Sends a message to the room.
+///
+/// \return true if the request was sent, false otherwise
 
 bool QXmppMucRoom::sendMessage(const QString &text)
 {
@@ -389,6 +397,8 @@ bool QXmppMucRoom::requestPermissions()
 
 /// Sets the room's permissions.
 ///
+/// \param permissions
+///
 /// \return true if the request was sent, false otherwise
 
 bool QXmppMucRoom::setPermissions(const QList<QXmppMucAdminIq::Item> &permissions)
diff --git a/src/QXmppMucManager.h b/src/QXmppMucManager.h
index a6f21aae..cf0dcd44 100644
--- a/src/QXmppMucManager.h
+++ b/src/QXmppMucManager.h
@@ -89,10 +89,7 @@ private:
 /// \brief The QXmppMucRoom class represents a multi-user chat room
 /// as defined by XEP-0045: Multi-User Chat.
 ///
-/// \code
-/// QXmppMucManager *manager = new QXmppMucManager;
-/// client->addExtension(manager);
-/// \endcode
+/// \sa QXmppMucManager
 
 class QXmppMucRoom : public QObject
 {
@@ -105,12 +102,13 @@ class QXmppMucRoom : public QObject
 
 public:
 
+    /// This enum is used to describe chat room actions.
     enum Action {
-        NoAction = 0,
-        SubjectAction = 1,
-        ConfigurationAction = 2,
-        PermissionsAction = 4,
-        KickAction = 8,
+        NoAction = 0,               ///< no action
+        SubjectAction = 1,          ///< change the room's subject
+        ConfigurationAction = 2,    ///< change the room's configuration
+        PermissionsAction = 4,      ///< change the room's permissions
+        KickAction = 8,             ///< kick users from the room
     };
     Q_DECLARE_FLAGS(Actions, Action)