summaryrefslogtreecommitdiff
path: root/mission-control-plugins
diff options
context:
space:
mode:
authorSimon McVittie <simon.mcvittie@collabora.co.uk>2011-05-11 10:58:22 +0100
committerVivek Dasmohapatra <vivek@collabora.co.uk>2011-05-11 15:25:05 +0100
commit88b5baf1db86614acff4ec8fca94667c7a55b49f (patch)
tree7722a6d276f51f8024abaad90a854fa171229849 /mission-control-plugins
parentf43ca7dae697528d26941874236c9f9dc7f8c36b (diff)
McpAccountManager: add brief documentation
Diffstat (limited to 'mission-control-plugins')
-rw-r--r--mission-control-plugins/account.c17
1 files changed, 17 insertions, 0 deletions
diff --git a/mission-control-plugins/account.c b/mission-control-plugins/account.c
index 721bfb55..fda29e4a 100644
--- a/mission-control-plugins/account.c
+++ b/mission-control-plugins/account.c
@@ -21,6 +21,23 @@
#include <mission-control-plugins/mission-control-plugins.h>
#include <mission-control-plugins/implementation.h>
+/**
+ * SECTION:account
+ * @title: McpAccountManager
+ * @short_description: Object representing the account manager, implemented
+ * by Mission Control
+ * @see_also: #McpAccountStorage
+ * @include: mission-control-plugins/mission-control-plugins.h
+ *
+ * This object represents the Telepathy AccountManager.
+ *
+ * Most virtual methods on the McpAccountStorageIface interface receive an
+ * object provided by Mission Control that implements this interface.
+ * It can be used to manipulate Mission Control's in-memory cache of accounts.
+ *
+ * Only Mission Control should implement this interface.
+ */
+
GType
mcp_account_manager_get_type (void)
{