From f999dd4bb51b23b2628f12724dd408f1ea2bb5b1 Mon Sep 17 00:00:00 2001 From: Jeremy Lainé Date: Thu, 28 Apr 2011 23:11:27 +0000 Subject: improve code documentation --- src/QXmppMucManager.cpp | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'src/QXmppMucManager.cpp') 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 &permissions) -- cgit v1.2.3