aboutsummaryrefslogtreecommitdiff
path: root/source/QXmppClient.cpp
diff options
context:
space:
mode:
authorJeremy Lainé <jeremy.laine@m4x.org>2010-08-10 10:08:42 +0000
committerJeremy Lainé <jeremy.laine@m4x.org>2010-08-10 10:08:42 +0000
commitba4d7aa237ef31fd18876b2621a37453007372e9 (patch)
tree89d465de902358260b06a58cfb7a81b444cd60d1 /source/QXmppClient.cpp
parente249f7acab9b3f14447cc0c675a480b7804f7ff4 (diff)
downloadqxmpp-ba4d7aa237ef31fd18876b2621a37453007372e9.tar.gz
improve documentation of setClientPresence
Diffstat (limited to 'source/QXmppClient.cpp')
-rw-r--r--source/QXmppClient.cpp7
1 files changed, 6 insertions, 1 deletions
diff --git a/source/QXmppClient.cpp b/source/QXmppClient.cpp
index 0daa98b6..5b96b5b7 100644
--- a/source/QXmppClient.cpp
+++ b/source/QXmppClient.cpp
@@ -321,9 +321,14 @@ QXmppPresence QXmppClient::clientPresence() const
/// Changes the presence of the connected client.
///
-/// If the presence type is QXmppPresence::Unavailable, the connection
+/// The connection to the server will be updated accordingly:
+///
+/// \li If the presence type is QXmppPresence::Unavailable, the connection
/// to the server will be closed.
///
+/// \li Otherwise, the connection to the server will be established
+/// as needed.
+///
/// \param presence QXmppPresence object
///