Link to ST[SC]::isRegistered() from the methods after which it should be checked

2 files changed, 16 insertions, 0 deletions

diff --git a/qt4/TelepathyQt4/stream-tube-client.cpp b/qt4/TelepathyQt4/stream-tube-client.cpp
index f8e06bcba..4830608a8 100644
--- a/qt4/TelepathyQt4/stream-tube-client.cpp
+++ b/qt4/TelepathyQt4/stream-tube-client.cpp
@@ -672,6 +672,10 @@ bool StreamTubeClient::acceptsAsUnix() const
  * needed security mechanism can be queried using its supportsIPv4SocketsWithSpecifiedAddress()
  * accessor.
  *
+ * The handler is registered on the bus at the latest when this method or setToAcceptAsUnix() is
+ * called for the first time, so one should check the return value of isRegistered() at that point
+ * to verify that was successful.
+ *
  * \param generator A pointer to the source address generator to use, or 0 to allow all
  * connections from the local host.
  *
@@ -709,6 +713,10 @@ void StreamTubeClient::setToAcceptAsTcp(TcpSourceAddressGenerator *generator)
  * its supportsIPv4SocketsWithSpecifiedAddress()
  * accessor.
  *
+ * The handler is registered on the bus at the latest when this method or setToAcceptAsTcp() is
+ * called for the first time, so one should check the return value of isRegistered() at that point
+ * to verify that was successful.
+ *
  * \param requireCredentials \c true to try and restrict connecting by UID, \c false to allow all
  * connections.
  *
diff --git a/qt4/TelepathyQt4/stream-tube-server.cpp b/qt4/TelepathyQt4/stream-tube-server.cpp
index c94bc0ebc..2132750c1 100644
--- a/qt4/TelepathyQt4/stream-tube-server.cpp
+++ b/qt4/TelepathyQt4/stream-tube-server.cpp
@@ -709,6 +709,10 @@ QVariantMap StreamTubeServer::exportedParameters() const
  * for an in-depth description of the parameter transfer mechanism, and a more flexible way to vary
  * the parameters between each handled tube.
  *
+ * The handler is registered on the bus at the latest when this method or another exportTcpSocket()
+ * overload is called for the first time, so one should check the return value of isRegistered() at
+ * that point to verify that was successful.
+ *
  * \param address The listen address of the socket.
  * \param port The port of the socket.
  * \param parameters The bootstrapping parameters in a string-value map.
@@ -774,6 +778,10 @@ void StreamTubeServer::exportTcpSocket(
  * local endpoint of tubes handled in the future, sending the parameters from the given \a generator
  * along with the offers.
  *
+ * The handler is registered on the bus at the latest when this method or another exportTcpSocket()
+ * overload is called for the first time, so one should check the return value of isRegistered() at
+ * that point to verify that was successful.
+ *
  * \param address The listen address of the socket.
  * \param port The port of the socket.
  * \param generator A pointer to the bootstrapping parameters generator.