[empathy] Add documentation for EmpathyNewMessageDialog.



commit 78f1e5cec3c97700d1ebd70fc949ba1ddf4ffa6b
Author: Jonny Lamb <jonny lamb collabora co uk>
Date:   Thu Apr 23 01:28:28 2009 +0100

    Add documentation for EmpathyNewMessageDialog.
    
    Signed-off-by: Jonny Lamb <jonny lamb collabora co uk>
---
 libempathy-gtk/empathy-new-message-dialog.c |   18 ++++++++++++++++++
 1 files changed, 18 insertions(+), 0 deletions(-)

diff --git a/libempathy-gtk/empathy-new-message-dialog.c b/libempathy-gtk/empathy-new-message-dialog.c
index b1a3509..3e6e3f1 100644
--- a/libempathy-gtk/empathy-new-message-dialog.c
+++ b/libempathy-gtk/empathy-new-message-dialog.c
@@ -44,6 +44,16 @@
 #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)
 {



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]