Document the "direction-changed" and "keys-changed" signals.

2003-09-30  Matthias Clasen  <maclas@gmx.de>

	* gdk/gdkkeys.c (gdk_keymap_class_init): Document the
	"direction-changed" and "keys-changed" signals.

	* gdk/gdkscreen.c (gdk_screen_class_init): Document the
	"size-changed" signal.

	* gdk/gdkdisplaymanager.c (gdk_display_manager_class_init):
	Document the "display-opened" signal.

	* gdk/gdkdisplay.c (gdk_display_close): Doc tweak.
	(gdk_display_class_init): Document the "closed" signal.

	* gdk/tmpl/keys.sgml: Small addition.

	* gdk/gdk-sections.txt: Add GdkDisplayClass and GdkScreenClass.

	* gdk-pixbuf/gdk-pixbuf-sections.txt: Add GdkPixbufLoaderClass.

4 files changed, 47 insertions, 1 deletions

diff --git a/gdk/gdkdisplay.c b/gdk/gdkdisplay.c
index 49fb89be17..5dfeb77ec6 100644
--- a/gdk/gdkdisplay.c
+++ b/gdk/gdkdisplay.c
@@ -121,6 +121,16 @@ gdk_display_class_init (GdkDisplayClass *class)
   object_class->finalize = gdk_display_finalize;
   object_class->dispose = gdk_display_dispose;
 
+  /**
+   * GdkDisplay::closed:
+   * @display: the object on which the signal is emitted
+   * @is_error: %TRUE if the display was closed due to an error
+   *
+   * The ::closed signal is emitted when the connection to the windowing
+   * system for @display is closed.
+   *
+   * Since: 2.2
+   */   
   signals[CLOSED] =
     g_signal_new ("closed",
 		  G_OBJECT_CLASS_TYPE (object_class),
@@ -173,7 +183,7 @@ gdk_display_finalize (GObject *object)
  * gdk_display_close:
  * @display: a #GdkDisplay
  *
- * Closes the connection windowing system for the given display,
+ * Closes the connection to the windowing system for the given display,
  * and cleans up associated resources.
  *
  * Since: 2.2
diff --git a/gdk/gdkdisplaymanager.c b/gdk/gdkdisplaymanager.c
index 5ca5ae23b3..7d7a7ad78e 100644
--- a/gdk/gdkdisplaymanager.c
+++ b/gdk/gdkdisplaymanager.c
@@ -100,6 +100,15 @@ gdk_display_manager_class_init (GdkDisplayManagerClass *klass)
   object_class->set_property = gdk_display_manager_set_property;
   object_class->get_property = gdk_display_manager_get_property;
 
+  /**
+   * GdkDisplayManager::display-opened:
+   * @display_manager: the object on which the signal is emitted
+   * @display: the opened display
+   *
+   * The ::display_opened signal is emitted when a display is opened.
+   *
+   * Since: 2.2
+   */
   signals[DISPLAY_OPENED] =
     g_signal_new ("display_opened",
 		  G_OBJECT_CLASS_TYPE (object_class),
diff --git a/gdk/gdkkeys.c b/gdk/gdkkeys.c
index 0ca76b86ea..b6af0d5c53 100644
--- a/gdk/gdkkeys.c
+++ b/gdk/gdkkeys.c
@@ -72,6 +72,15 @@ gdk_keymap_class_init (GdkKeymapClass *klass)
 {
   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 
+  /**
+   * GdkKeymap::direction-changed:
+   * @keymap: the object on which the signal is emitted
+   * 
+   * The ::direction_changed signal gets emitted when the direction of
+   * the keymap changes. 
+   *
+   * Since: 2.0
+   */
   signals[DIRECTION_CHANGED] =
     g_signal_new ("direction_changed",
 		  G_OBJECT_CLASS_TYPE (object_class),
@@ -81,6 +90,15 @@ gdk_keymap_class_init (GdkKeymapClass *klass)
 		  g_cclosure_marshal_VOID__VOID,
 		  G_TYPE_NONE,
 		  0);
+  /**
+   * GdkKeymap::keys-changed:
+   * @keymap: the object on which the signal is emitted
+   *
+   * The ::keys_changed signal is emitted when the mapping represented by
+   * @keymap changes.
+   *
+   * Since: 2.2
+   */
   signals[KEYS_CHANGED] =
     g_signal_new ("keys_changed",
 		  G_OBJECT_CLASS_TYPE (object_class),
diff --git a/gdk/gdkscreen.c b/gdk/gdkscreen.c
index 114dc49df2..0492ab2095 100644
--- a/gdk/gdkscreen.c
+++ b/gdk/gdkscreen.c
@@ -67,6 +67,15 @@ gdk_screen_get_type (void)
 static void
 gdk_screen_class_init (GdkScreenClass *klass)
 {
+  /**
+   * GdkScreen::size-changed:
+   * @screen: the object on which the signal is emitted
+   * 
+   * The ::size_changed signal is emitted when the pixel width or 
+   * height of a screen changes.
+   *
+   * Since: 2.2
+   */
   signals[SIZE_CHANGED] =
     g_signal_new ("size_changed",
                   G_OBJECT_CLASS_TYPE (klass),