Add documentation for EmpathyNewMessageDialog.
authorJonny Lamb <jonny.lamb@collabora.co.uk>
Thu, 23 Apr 2009 00:28:28 +0000 (01:28 +0100)
committerJonny Lamb <jonny.lamb@collabora.co.uk>
Thu, 23 Apr 2009 00:28:28 +0000 (01:28 +0100)
Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk>
libempathy-gtk/empathy-new-message-dialog.c

index b1a35095b75a7fbbf7a6458fd64633978f6574ca..3e6e3f11d3a10ecf8a8a7b727f042db81fd6d7cc 100644 (file)
 #include "empathy-new-message-dialog.h"
 #include "empathy-account-chooser.h"
 
+/**
+ * SECTION:empathy-new-message-dialog
+ * @title: EmpathyNewMessageDialog
+ * @short_description: A dialog to show a new message
+ * @include: libempathy-gtk/empathy-new-message-dialog.h
+ *
+ * #EmpathyNewMessageDialog is a dialog which allows a text chat or
+ * call to be started with any contact on any enabled account.
+ */
+
 typedef struct {
        GtkWidget *dialog;
        GtkWidget *table_contact;
@@ -242,6 +252,14 @@ new_message_dialog_destroy_cb (GtkWidget               *widget,
        g_free (dialog);
 }
 
+/**
+ * empathy_new_message_dialog_show:
+ * @parent: parent #GtkWindow of the dialog
+ *
+ * Create a new #EmpathyNewMessageDialog and show it.
+ *
+ * Return value: the new #EmpathyNewMessageDialog
+ */
 GtkWidget *
 empathy_new_message_dialog_show (GtkWindow *parent)
 {