[telepathy-glib/master] account-manager: document _get_most_available_presence more

Jonny Lamb jonny.lamb at collabora.co.uk
Tue Sep 22 03:51:23 PDT 2009


Signed-off-by: Jonny Lamb <jonny.lamb at collabora.co.uk>
---
 telepathy-glib/account-manager.c |    9 ++++++++-
 1 files changed, 8 insertions(+), 1 deletions(-)

diff --git a/telepathy-glib/account-manager.c b/telepathy-glib/account-manager.c
index ef4128a..ecd6fe9 100644
--- a/telepathy-glib/account-manager.c
+++ b/telepathy-glib/account-manager.c
@@ -1102,7 +1102,14 @@ tp_account_manager_set_all_requested_presences (TpAccountManager *manager,
  * @status: a string to fill with the actual status
  * @message: a string to fill with the actual status message
  *
- * <!-- -->
+ * Gets the most available presence over all accounts in @manager. This
+ * function does not average presences across all accounts, but it merely
+ * finds the "most available" presence. As a result, there is a guarantee
+ * that there exists at least one account in @manager with the returned
+ * presence.
+ *
+ * If no accounts are enabled or valid the output will be
+ * (%TP_CONNECTION_PRESENCE_TYPE_OFFLINE, "offline", "").
  *
  * Returns: the most available presence across all accounts
  *
-- 
1.5.6.5




More information about the telepathy-commits mailing list