diff options
| author | Olli Salli <ollisal@gmail.com> | 2011-10-10 19:23:35 +0300 |
|---|---|---|
| committer | Olli Salli <ollisal@gmail.com> | 2011-10-10 19:23:35 +0300 |
| commit | e90712845cda1cd92a099a6475e97d68c9e1f0b2 (patch) | |
| tree | ca940fe6552e0d206728ff1db1a9f60f0034a7b6 | |
| parent | ad8972e9c0da42abb3e447d22bca928c03a09d27 (diff) | |
Explain what ST[SC]::monitorsConnections() affects better
| -rw-r--r-- | TelepathyQt4/stream-tube-client.cpp | 6 | ||||
| -rw-r--r-- | TelepathyQt4/stream-tube-server.cpp | 6 |
2 files changed, 10 insertions, 2 deletions
diff --git a/TelepathyQt4/stream-tube-client.cpp b/TelepathyQt4/stream-tube-client.cpp index d8044a13..f8e06bcb 100644 --- a/TelepathyQt4/stream-tube-client.cpp +++ b/TelepathyQt4/stream-tube-client.cpp @@ -605,7 +605,11 @@ bool StreamTubeClient::isRegistered() const * Return whether connection monitoring is enabled on this client. * * For technical reasons, connection monitoring can't be enabled when the client is already running, - * so there is no corresponding setter method. + * so there is no corresponding setter method. It has to be enabled by passing \c true as the \a + * monitorConnections parameter to the create() method. + * + * If connection monitoring isn't enabled, newConnection() and connectionClosed() won't be + * emitted and connections() won't be populated. * * \return \c true if monitoring is enabled, \c false if not. */ diff --git a/TelepathyQt4/stream-tube-server.cpp b/TelepathyQt4/stream-tube-server.cpp index 3a4d22a5..c94bc0eb 100644 --- a/TelepathyQt4/stream-tube-server.cpp +++ b/TelepathyQt4/stream-tube-server.cpp @@ -642,7 +642,11 @@ bool StreamTubeServer::isRegistered() const * Return whether connection monitoring is enabled on this server. * * For technical reasons, connection monitoring can't be enabled when the server is already running, - * so there is no corresponding setter method. + * so there is no corresponding setter method. It has to be enabled by passing \c true as the \a + * monitorConnections parameter to the create() method. + * + * If connection monitoring isn't enabled, newTcpConnection() and tcpConnectionClosed() won't be + * emitted and tcpConnections() won't be populated. * * \return \c true if monitoring is enabled, \c false if not. */ |