Misc. gtk-doc updates, including being more explicit about refs.

[empathy.git] / libempathy-gtk / empathy-contact-widget.h

diff --git a/libempathy-gtk/empathy-contact-widget.h b/libempathy-gtk/empathy-contact-widget.h
index 595f68fc59b1e780627132406a2f5f91e17d3d85..0da5580a30149af963defeebe1fd115655de815b 100644 (file)
--- a/libempathy-gtk/empathy-contact-widget.h
+++ b/libempathy-gtk/empathy-contact-widget.h
@@ -29,23 +29,45 @@
 
 G_BEGIN_DECLS
 
-typedef enum {
-       EMPATHY_CONTACT_WIDGET_EDIT_NONE    = 0,
-       EMPATHY_CONTACT_WIDGET_EDIT_ALIAS   = 1 << 0,
-       EMPATHY_CONTACT_WIDGET_EDIT_AVATAR  = 1 << 1,
-       EMPATHY_CONTACT_WIDGET_EDIT_ACCOUNT = 1 << 2,
-       EMPATHY_CONTACT_WIDGET_EDIT_ID      = 1 << 3,
-       EMPATHY_CONTACT_WIDGET_EDIT_GROUPS  = 1 << 4,
+/**
+ * EmpathyContactWidgetFlags:
+ * @EMPATHY_CONTACT_WIDGET_EDIT_NONE: Don't show any widgets to edit any details
+ *  of the contact. This should be the option for widgets that merely display
+ *  information about a contact.
+ * @EMPATHY_CONTACT_WIDGET_EDIT_ALIAS: Show a #GtkEntry allowing changes to the
+ *  contact's alias.
+ * @EMPATHY_CONTACT_WIDGET_EDIT_AVATAR: Show an #EmpathyAvatarChooser allowing
+ *  changes to the contact's avatar.
+ * @EMPATHY_CONTACT_WIDGET_EDIT_ACCOUNT: Show an #EmpathyAccountChooser allowing
+ *  changes to the contact's account.
+ * @EMPATHY_CONTACT_WIDGET_EDIT_ID: Show a #GtkEntry allowing changes to the
+ *  contact's identifier.
+ * @EMPATHY_CONTACT_WIDGET_EDIT_GROUPS: Show a widget to change the groups the
+ *  contact is in.
+ * @EMPATHY_CONTACT_WIDGET_FOR_TOOLTIP: Make widgets more designed for a tooltip.
+ *  For example, make widgets not selectable.
+ *
+ * Flags used when creating an #EmpathyContactWidget to specify which features
+ * should be available.
+ */
+typedef enum
+{
+  EMPATHY_CONTACT_WIDGET_EDIT_NONE    = 0,
+  EMPATHY_CONTACT_WIDGET_EDIT_ALIAS   = 1 << 0,
+  EMPATHY_CONTACT_WIDGET_EDIT_AVATAR  = 1 << 1,
+  EMPATHY_CONTACT_WIDGET_EDIT_ACCOUNT = 1 << 2,
+  EMPATHY_CONTACT_WIDGET_EDIT_ID      = 1 << 3,
+  EMPATHY_CONTACT_WIDGET_EDIT_GROUPS  = 1 << 4,
+  EMPATHY_CONTACT_WIDGET_FOR_TOOLTIP  = 1 << 5,
 } EmpathyContactWidgetFlags;
 
-GtkWidget *     empathy_contact_widget_new                (EmpathyContact                  *contact,
-                                                          EmpathyContactWidgetFlags        flags);
-EmpathyContact *empathy_contact_widget_get_contact        (GtkWidget                       *widget);
-void            empathy_contact_widget_set_contact        (GtkWidget                       *widget,
-                                                          EmpathyContact                  *contact);
-void            empathy_contact_widget_set_account_filter (GtkWidget                       *widget,
-                                                          EmpathyAccountChooserFilterFunc  filter,
-                                                          gpointer                         user_data);
+GtkWidget * empathy_contact_widget_new (EmpathyContact *contact,
+    EmpathyContactWidgetFlags flags);
+EmpathyContact *empathy_contact_widget_get_contact (GtkWidget *widget);
+void empathy_contact_widget_set_contact (GtkWidget *widget,
+    EmpathyContact *contact);
+void empathy_contact_widget_set_account_filter (GtkWidget *widget,
+    EmpathyAccountChooserFilterFunc filter, gpointer user_data);
 
 G_END_DECLS