Add documentation for EmpathyPresenceChooser.

Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk>

diff --git a/libempathy-gtk/empathy-presence-chooser.c b/libempathy-gtk/empathy-presence-chooser.c
index 8e9574bc533c10798a195510079395458831785e..36e8376927a1a47cfb6eceb58618c668ccd7e65a 100644 (file)
--- a/libempathy-gtk/empathy-presence-chooser.c
+++ b/libempathy-gtk/empathy-presence-chooser.c
@@ -47,6 +47,23 @@
 #include "empathy-images.h"
 #include "empathy-presence-chooser.h"
 
+/**
+ * SECTION:empathy-presence-chooser
+ * @title:EmpathyPresenceChooser
+ * @short_description: A widget used to change presence
+ * @include: libempathy-gtk/empathy-presence-chooser.h
+ *
+ * #EmpathyPresenceChooser is a widget which extends #GtkComboBoxEntry
+ * to change presence.
+ */
+
+/**
+ * EmpathyAccountChooser:
+ * @parent: parent object
+ *
+ * Widget which extends #GtkComboBoxEntry to change presence.
+ */
+
 /* Flashing delay for icons (milliseconds). */
 #define FLASH_TIMEOUT 500
 
@@ -789,6 +806,13 @@ presence_chooser_finalize (GObject *object)
        G_OBJECT_CLASS (empathy_presence_chooser_parent_class)->finalize (object);
 }
 
+/**
+ * empathy_presence_chooser_new:
+ *
+ * Creates a new #EmpathyPresenceChooser widget.
+ *
+ * Return value: A new #EmpathyPresenceChooser widget
+ */
 GtkWidget *
 empathy_presence_chooser_new (void)
 {
@@ -946,6 +970,13 @@ presence_chooser_flash_stop (EmpathyPresenceChooser *chooser,
                                           empathy_icon_name_for_presence (state));
 }
 
+/**
+ * empathy_presence_chooser_create_menu:
+ *
+ * Creates a new #GtkMenu allowing users to change their presence from a menu.
+ *
+ * Return value: a new #GtkMenu for changing presence in a menu.
+ */
 GtkWidget *
 empathy_presence_chooser_create_menu (void)
 {

diff --git a/libempathy-gtk/empathy-presence-chooser.h b/libempathy-gtk/empathy-presence-chooser.h
index 138e1dc7feec69f0be8ee7efe102a2b689e514b9..dab95f5537a043eace835c24bb55d61574fe5e1e 100644 (file)
--- a/libempathy-gtk/empathy-presence-chooser.h
+++ b/libempathy-gtk/empathy-presence-chooser.h
@@ -43,6 +43,8 @@ typedef struct _EmpathyPresenceChooserClass EmpathyPresenceChooserClass;
 
 struct _EmpathyPresenceChooser {
        GtkComboBoxEntry parent;
+
+       /*<private>*/
        gpointer priv;
 };