From 8849303e4492acdab9605129d41fffe2b4585c7b Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Thu, 10 May 2012 10:10:29 +0200
Subject: fix some documentation warnings

---
 src/base/QXmppMucIq.cpp | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'src/base/QXmppMucIq.cpp')

diff --git a/src/base/QXmppMucIq.cpp b/src/base/QXmppMucIq.cpp
index 97328a2f..30dc9697 100644
--- a/src/base/QXmppMucIq.cpp
+++ b/src/base/QXmppMucIq.cpp
@@ -33,6 +33,8 @@ QXmppMucItem::QXmppMucItem()
 {
 }
 
+/// Returns true if the current item is null.
+
 bool QXmppMucItem::isNull() const
 {
     return m_actor.isEmpty() &&
@@ -43,11 +45,17 @@ bool QXmppMucItem::isNull() const
            m_role == UnspecifiedRole;
 }
 
+/// Returns the actor for this item, for instance the admin who kicked
+/// a user out of a room.
+
 QString QXmppMucItem::actor() const
 {
     return m_actor;
 }
 
+/// Sets the \a actor for this item, for instance the admin who kicked
+/// a user out of a room.
+
 void QXmppMucItem::setActor(const QString &actor)
 {
     m_actor = actor;
@@ -135,11 +143,17 @@ void QXmppMucItem::setNick(const QString &nick)
     m_nick = nick;
 }
 
+/// Returns the reason for this item, for example the reason for kicking
+/// a user out of a room.
+
 QString QXmppMucItem::reason() const
 {
     return m_reason;
 }
 
+/// Sets the \a reason for this item, for example the reason for kicking
+/// a user out of a room.
+
 void QXmppMucItem::setReason(const QString &reason)
 {
     m_reason = reason;
-- 
cgit v1.2.3