[telepathy-glib/master] account: document a use-case for _ensure_connection
Jonny Lamb
jonny.lamb at collabora.co.uk
Fri Sep 25 13:45:43 PDT 2009
Signed-off-by: Jonny Lamb <jonny.lamb at collabora.co.uk>
---
telepathy-glib/account.c | 4 ++++
1 files changed, 4 insertions(+), 0 deletions(-)
diff --git a/telepathy-glib/account.c b/telepathy-glib/account.c
index 28086b6..768d975 100644
--- a/telepathy-glib/account.c
+++ b/telepathy-glib/account.c
@@ -1510,6 +1510,10 @@ tp_account_get_connection (TpAccount *account)
* This function does not return a new ref and it is not guaranteed that the
* returned #TpConnection object is ready.
*
+ * The use-case for this function is in a HandleChannels callback and you
+ * already know the object path for the connection, so you can let @account
+ * create its #TpConnection and return it for use.
+ *
* Returns: the connection of the account, or %NULL if either the object path
* @path is invalid or it is the null-value "/"
*
--
1.5.6.5
More information about the telepathy-commits
mailing list