Move signal and property documentation inline, fix a problem with the

2007-11-25  Matthias Clasen  <mclasen@redhat.com>

        * gtk/gtkdialog.c: Move signal and property documentation inline,
        fix a problem with the ::response signal docs.  (#499133, Josselin
        Mouette)

svn path=/trunk/; revision=19038

diff --git a/ChangeLog b/ChangeLog
index 3c91ef7dfd95539aec18e7f1677697be61ed2658..5ee3155c3514c3a725424def48508d76e83d3bf4 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2007-11-25  Matthias Clasen  <mclasen@redhat.com>
+
+       * gtk/gtkdialog.c: Move signal and property documentation inline,
+       fix a problem with the ::response signal docs.  (#499133, Josselin
+       Mouette)
+
 2007-11-22 15:48:26  Tim Janik  <timj@imendio.com>
 
         * Makefile.decl: initialize automake variables EXTRA_DIST and

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 96978dc9527ed78ec0f46bd62823235a9324de05..60d4a913f131b36b2e248984f12fe68cb01e7a02 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,7 @@
+2007-11-25  Matthias Clasen <mclasen@redhat.com>
+
+       * gtk/tmpl/gtkdialog.sgml: Move signal docs inline.
+
 2007-11-19  Matthias Clasen <mclasen@redhat.com>
 
        * gtk/tmpl/gtknotebook.sgml:

diff --git a/docs/reference/gtk/tmpl/gtkdialog.sgml b/docs/reference/gtk/tmpl/gtkdialog.sgml
index d3e2b02e19a94c14a6135461e4d0f63e12ef7c08..0baf505499089a2a4ce2796628096bb8209bb3a1 100644 (file)
--- a/docs/reference/gtk/tmpl/gtkdialog.sgml
+++ b/docs/reference/gtk/tmpl/gtkdialog.sgml
@@ -190,14 +190,11 @@ as any other #GtkHButtonBox.
 
 <!-- ##### SIGNAL GtkDialog::response ##### -->
 <para>
-Emitted when an action widget is clicked, the dialog receives a delete event, or
-the application programmer calls gtk_dialog_response(). On a delete event, the
-response ID is #GTK_RESPONSE_NONE. Otherwise, it depends on which action widget
-was clicked.
+
 </para>
 
-@dialog: the object which received the signal.
-@arg1: the response ID
+@dialog:
+@arg1:
 
 <!-- ##### ARG GtkDialog:has-separator ##### -->
 <para>

diff --git a/gtk/gtkdialog.c b/gtk/gtkdialog.c
index 83c771a044ff77f4d44e8d6e1080658da3577b8d..8760c19cafde53dbcbfeeacfdccd158fac804de3 100644 (file)
--- a/gtk/gtkdialog.c
+++ b/gtk/gtkdialog.c
@@ -133,6 +133,11 @@ gtk_dialog_class_init (GtkDialogClass *class)
   
   g_type_class_add_private (gobject_class, sizeof (GtkDialogPrivate));
 
+  /**
+   * GtkDialog:has-separator:
+   *
+   * When %TRUE, the dialog has a separator bar above its buttons.
+   */
   g_object_class_install_property (gobject_class,
                                    PROP_HAS_SEPARATOR,
                                    g_param_spec_boolean ("has-separator",
@@ -140,7 +145,17 @@ gtk_dialog_class_init (GtkDialogClass *class)
                                                         P_("The dialog has a separator bar above its buttons"),
                                                          TRUE,
                                                          GTK_PARAM_READWRITE));
-  
+
+  /**
+   * GtkDialog::response:
+   * @dialog: the object on which the signal is emitted
+   * @response_id: the response ID
+   * 
+   * Emitted when an action widget is clicked, the dialog receives a 
+   * delete event, or the application programmer calls gtk_dialog_response(). 
+   * On a delete event, the response ID is #GTK_RESPONSE_DELETE_EVENT. 
+   * Otherwise, it depends on which action widget was clicked.
+   */
   dialog_signals[RESPONSE] =
     g_signal_new (I_("response"),
                  G_OBJECT_CLASS_TYPE (class),
@@ -151,6 +166,16 @@ gtk_dialog_class_init (GtkDialogClass *class)
                  G_TYPE_NONE, 1,
                  G_TYPE_INT);
 
+  /**
+   * GtkDialog::close:
+   *
+   * The ::close signal is a 
+   * <link linkend="keybinding-signals">keybinding signal</link>
+   * which getrs emitted when the user uses a keybinding to close
+   * the dialog.
+   *
+   * The default binding for this signal is the Escape key.
+   */ 
   dialog_signals[CLOSE] =
     g_signal_new (I_("close"),
                  G_OBJECT_CLASS_TYPE (class),
@@ -188,8 +213,7 @@ gtk_dialog_class_init (GtkDialogClass *class)
 
   binding_set = gtk_binding_set_by_class (class);
   
-  gtk_binding_entry_add_signal (binding_set, GDK_Escape, 0,
-                                "close", 0);
+  gtk_binding_entry_add_signal (binding_set, GDK_Escape, 0, "close", 0);
 }
 
 static void