[Telepathy-commits] [telepathy-qt4/master] ConnectionManager: document the relationship between isReady() and becomeReady()

[Simon McVittie]

Also comment that the name "becomeReady()" isn't ideal.
---
 TelepathyQt4/cli-connection-manager.h |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)

diff --git a/TelepathyQt4/cli-connection-manager.h b/TelepathyQt4/cli-connection-manager.h
index 8d0fc0c..650ff26 100644
--- a/TelepathyQt4/cli-connection-manager.h
+++ b/TelepathyQt4/cli-connection-manager.h
@@ -227,8 +227,18 @@ public:
                 *baseInterface());
     }
 
+    /**
+     * Return whether this object has finished its initial setup.
+     *
+     * This is mostly useful as a sanity check, in code that shouldn't be run
+     * until the object is ready. To wait for the object to be ready, call
+     * becomeReady() and connect to the finished signal on the result.
+     *
+     * \return \c true if the object has finished initial setup
+     */
     bool isReady() const;
 
+    // FIXME: a better name for this would be nice
     /**
      * Return a pending operation which will succeed when this object finishes
      * its initial setup, or will fail if a fatal error occurs during this
-- 
1.5.6.5