[empathy] Add documentation for EmpathyPresenceChooser.
- From: Jonny Lamb <jonnylamb src gnome org>
- To: svn-commits-list gnome org
- Subject: [empathy] Add documentation for EmpathyPresenceChooser.
- Date: Thu, 23 Apr 2009 05:13:13 -0400 (EDT)
commit 56fa37ef682ea7e8f676f4c974b76c06242466d2
Author: Jonny Lamb <jonny lamb collabora co uk>
Date: Thu Apr 23 00:27:42 2009 +0100
Add documentation for EmpathyPresenceChooser.
Signed-off-by: Jonny Lamb <jonny lamb collabora co uk>
---
libempathy-gtk/empathy-presence-chooser.c | 31 +++++++++++++++++++++++++++++
libempathy-gtk/empathy-presence-chooser.h | 2 +
2 files changed, 33 insertions(+), 0 deletions(-)
diff --git a/libempathy-gtk/empathy-presence-chooser.c b/libempathy-gtk/empathy-presence-chooser.c
index 8e9574b..36e8376 100644
--- 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 138e1dc..dab95f5 100644
--- 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;
};
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]