idle: added a comment to explain _is_just_connected

[empathy.git] / libempathy / empathy-idle.c

diff --git a/libempathy/empathy-idle.c b/libempathy/empathy-idle.c
index d4bd224d8f8227ee151b444f02c11b669eefce60..8a0fcd88d1bcebc3904cb3fc352eeb4de4632d56 100644 (file)
--- a/libempathy/empathy-idle.c
+++ b/libempathy/empathy-idle.c
@@ -723,6 +723,9 @@ empathy_idle_get_requested_presence (EmpathyIdle *idle,
        return priv->requested_presence_type;
 }
 
+/* This function returns %TRUE if EmpathyIdle considers the account
+ * @account as having just connected recently. Otherwise, it returns
+ * %FALSE. In doubt, %FALSE is returned. */
 gboolean
 empathy_idle_account_is_just_connected (EmpathyIdle *idle,
                                        TpAccount *account)