[Telepathy-commits] [telepathy-qt4/master] Connection: Updated requestConnect doc.

Andre Moreira Magalhaes (andrunko) andre.magalhaes at collabora.co.uk
Tue Jan 27 05:52:18 PST 2009


---
 TelepathyQt4/Client/connection.cpp |    7 ++++---
 1 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/TelepathyQt4/Client/connection.cpp b/TelepathyQt4/Client/connection.cpp
index e430c41..88e7bff 100644
--- a/TelepathyQt4/Client/connection.cpp
+++ b/TelepathyQt4/Client/connection.cpp
@@ -1378,9 +1378,10 @@ PendingOperation *Connection::becomeReady(Features requestedFeatures)
 
 /**
  * Start an asynchronous request that the connection be connected.
- * The returned PendingOperation object will signal the success or failure
- * of this request; under normal circumstances, it can be expected to
- * succeed.
+ *
+ * The returned PendingOperation will finish successfully when the connection
+ * has reached StatusConnected and the requested \a features are all ready, or
+ * finish with an error if a fatal error occurs during that process.
  *
  * \return A %PendingOperation, which will emit finished when the
  *         request finishes.
-- 
1.5.6.5




More information about the Telepathy-commits mailing list