From 94545f5d9303dc1e04ff3d1260bc62ce6f2ec5ee Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Wed, 5 Sep 2012 16:27:29 +0200
Subject: clarify JID formats

---
 src/client/QXmppMucManager.cpp | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'src/client/QXmppMucManager.cpp')

diff --git a/src/client/QXmppMucManager.cpp b/src/client/QXmppMucManager.cpp
index c5dd4beb..7b981459 100644
--- a/src/client/QXmppMucManager.cpp
+++ b/src/client/QXmppMucManager.cpp
@@ -409,7 +409,7 @@ QString QXmppMucRoom::participantFullJid(const QString &jid) const
 
 /// Returns the presence for the given participant.
 ///
-/// \param jid
+/// The specified \a jid is the Occupant JID of the form "room@service/nick".
 
 QXmppPresence QXmppMucRoom::participantPresence(const QString &jid) const
 {
@@ -423,6 +423,8 @@ QXmppPresence QXmppMucRoom::participantPresence(const QString &jid) const
 }
 
 /// Returns the list of participant JIDs.
+///
+/// These JIDs are Occupant JIDs of the form "room@service/nick".
 
 QStringList QXmppMucRoom::participants() const
 {
-- 
cgit v1.2.3