[Telepathy-commits] [telepathy-qt4/master] Oggis-review: document the states the channel will end up in depending on what state it is in when close() is called.

[George Goldberg]

---
 TelepathyQt4/cli-channel.h |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)

diff --git a/TelepathyQt4/cli-channel.h b/TelepathyQt4/cli-channel.h
index aedbc6e..e9ac04e 100644
--- a/TelepathyQt4/cli-channel.h
+++ b/TelepathyQt4/cli-channel.h
@@ -210,6 +210,11 @@ public Q_SLOTS:
      * in either the ReadinessDead or ReadinessClosed state, a DBus error of type
      * TELEPATHY_ERROR_NOT_AVAILABLE will be returned.
      *
+     * If the introspection of a channel is not complete when close() is called,
+     * the channel readiness will change to ReadinessDead instead of
+     * ReadinessClosed, which results if the channel is closed after the
+     * introspection is complete.
+     *
      * \return QDBusPendingReply object for the call to Close() on the Channel
      *         interface.
      */
-- 
1.5.6.5