aboutsummaryrefslogtreecommitdiff
path: root/src/QXmppMucManager.cpp
diff options
context:
space:
mode:
authorJeremy Lainé <jeremy.laine@m4x.org>2011-04-28 23:11:27 +0000
committerJeremy Lainé <jeremy.laine@m4x.org>2011-04-28 23:11:27 +0000
commitf999dd4bb51b23b2628f12724dd408f1ea2bb5b1 (patch)
tree653e7328e710ec99214e133bff132ed268c3f890 /src/QXmppMucManager.cpp
parentd9c96b1688a2f3af0df05b453bd4282b7c3e99f3 (diff)
downloadqxmpp-f999dd4bb51b23b2628f12724dd408f1ea2bb5b1.tar.gz
improve code documentation
Diffstat (limited to 'src/QXmppMucManager.cpp')
-rw-r--r--src/QXmppMucManager.cpp10
1 files changed, 10 insertions, 0 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)