aboutsummaryrefslogtreecommitdiff
path: root/src/base/QXmppMucIq.cpp
diff options
context:
space:
mode:
authorJeremy Lainé <jeremy.laine@m4x.org>2012-05-10 10:10:29 +0200
committerJeremy Lainé <jeremy.laine@m4x.org>2012-05-10 10:10:29 +0200
commit8849303e4492acdab9605129d41fffe2b4585c7b (patch)
tree10213fadd9077c3bce93e25552105fe8e2f1f7fb /src/base/QXmppMucIq.cpp
parent78303d76882be5ff31e4798893e19cd8c9a59c43 (diff)
downloadqxmpp-8849303e4492acdab9605129d41fffe2b4585c7b.tar.gz
fix some documentation warnings
Diffstat (limited to 'src/base/QXmppMucIq.cpp')
-rw-r--r--src/base/QXmppMucIq.cpp14
1 files changed, 14 insertions, 0 deletions
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;