From 462b560f917d51a81c5d6ffa4e21e4e5b0194a99 Mon Sep 17 00:00:00 2001
From: Lars Uebernickel <lars.uebernickel@canonical.com>
Date: Wed, 29 Aug 2012 09:17:14 +0200
Subject: libmessaging-menu: add documentation

Adds an overview description of the messaging menu and documentation for
enums, properties, and signals.
---
 libmessaging-menu/messaging-menu.h | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'libmessaging-menu/messaging-menu.h')

diff --git a/libmessaging-menu/messaging-menu.h b/libmessaging-menu/messaging-menu.h
index e767099..4668319 100644
--- a/libmessaging-menu/messaging-menu.h
+++ b/libmessaging-menu/messaging-menu.h
@@ -29,6 +29,11 @@ G_BEGIN_DECLS
 #define MESSAGING_MENU_APP_CLASS(c)     (G_TYPE_CHECK_CLASS_CAST ((c), MESSAGING_MENU_TYPE_APP, MessagingMenuAppClass))
 #define MESSAGING_MENU_IS_APP(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), MESSAGING_MENU_TYPE_APP))
 
+/**
+ * MessagingMenuStatus:
+ *
+ * An enumeration for the possible chat statuses the messaging menu can be in.
+ */
 typedef enum {
   MESSAGING_MENU_STATUS_AVAILABLE,
   MESSAGING_MENU_STATUS_AWAY,
-- 
cgit v1.2.3