summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonny Lamb <jonny.lamb@collabora.co.uk>2011-05-02 13:53:19 +0100
committerJonny Lamb <jonny.lamb@collabora.co.uk>2011-05-02 13:53:19 +0100
commita375e043d82e974666b7a9f9f1fea6e22efda42e (patch)
treea580db19783d336170f832f410d3c24b00be2928
parent94f960989fa9262997ef891fdfe38bf663ae45ee (diff)
status: clarify new behaviour of tp_yts_status_ensure()
Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk>
-rw-r--r--telepathy-ytstenut-glib/status.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/telepathy-ytstenut-glib/status.c b/telepathy-ytstenut-glib/status.c
index 5e5b657..1f591f1 100644
--- a/telepathy-ytstenut-glib/status.c
+++ b/telepathy-ytstenut-glib/status.c
@@ -606,7 +606,11 @@ on_account_timeout (gpointer user_data)
* @callback: A callback which should be called when the result is ready
* @user_data: Data to pass to the callback
*
- * Create a #TpYtsStatus object for a Ytstenut enabled connection.
+ * Create a #TpYtsStatus object for a Ytstenut enabled
+ * connection. @account must be either connected, or in the process of
+ * connecting. Calling tp_yts_account_manager_hold() before this
+ * function (even if haven't re-entered the mainloop yet) is
+ * acceptable for connecting the account.
*/
void
tp_yts_status_ensure_async (TpAccount *account,