[gtk+/xi2] Add missing docs for GdkDevice properties.



commit b989e5ba3428a96b4976d6af9b8fb38b22af3c82
Author: Carlos Garnacho <carlos gnome org>
Date:   Wed Jan 20 19:18:57 2010 +0100

    Add missing docs for GdkDevice properties.

 gdk/gdkdevice.c |   47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 47 insertions(+), 0 deletions(-)
---
diff --git a/gdk/gdkdevice.c b/gdk/gdkdevice.c
index 7530826..9160b93 100644
--- a/gdk/gdkdevice.c
+++ b/gdk/gdkdevice.c
@@ -87,6 +87,11 @@ gdk_device_class_init (GdkDeviceClass *klass)
   object_class->set_property = gdk_device_set_property;
   object_class->get_property = gdk_device_get_property;
 
+  /**
+   * GdkDevice:display:
+   *
+   * The #GdkDisplay the #GdkDevice pertains to.
+   */
   g_object_class_install_property (object_class,
 				   PROP_DISPLAY,
 				   g_param_spec_object ("display",
@@ -95,6 +100,11 @@ gdk_device_class_init (GdkDeviceClass *klass)
                                                         GDK_TYPE_DISPLAY,
                                                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
                                                         G_PARAM_STATIC_STRINGS));
+  /**
+   * GdkDevice:device-manager:
+   *
+   * The #GdkDeviceManager the #GdkDevice pertains to.
+   */
   g_object_class_install_property (object_class,
 				   PROP_DEVICE_MANAGER,
 				   g_param_spec_object ("device-manager",
@@ -103,6 +113,11 @@ gdk_device_class_init (GdkDeviceClass *klass)
                                                         GDK_TYPE_DEVICE_MANAGER,
                                                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
                                                         G_PARAM_STATIC_STRINGS));
+  /**
+   * GdkDevice:name:
+   *
+   * The device name.
+   */
   g_object_class_install_property (object_class,
 				   PROP_NAME,
 				   g_param_spec_string ("name",
@@ -111,6 +126,11 @@ gdk_device_class_init (GdkDeviceClass *klass)
                                                         NULL,
                                                         G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
                                                         G_PARAM_STATIC_STRINGS));
+  /**
+   * GdkDevice:type:
+   *
+   * Device role in the device manager.
+   */
   g_object_class_install_property (object_class,
                                    PROP_TYPE,
                                    g_param_spec_enum ("type",
@@ -120,6 +140,12 @@ gdk_device_class_init (GdkDeviceClass *klass)
                                                       GDK_DEVICE_TYPE_MASTER,
                                                       G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
                                                       G_PARAM_STATIC_STRINGS));
+  /**
+   * GdkDevice:associated-device:
+   *
+   * Associated pointer or keyboard to this device, if any. Devices of type #GDK_DEVICE_TYPE_MASTER
+   * always come in keyboard/pointer pairs. Other device types will have a %NULL associated device.
+   */
   g_object_class_install_property (object_class,
 				   PROP_ASSOCIATED_DEVICE,
 				   g_param_spec_object ("associated-device",
@@ -127,6 +153,11 @@ gdk_device_class_init (GdkDeviceClass *klass)
                                                         P_("Associated pointer or keyboard to this device"),
                                                         GDK_TYPE_DEVICE,
                                                         G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
+  /**
+   * GdkDevice:input-source:
+   *
+   * Source type for the device.
+   */
   g_object_class_install_property (object_class,
 				   PROP_INPUT_SOURCE,
 				   g_param_spec_enum ("input-source",
@@ -136,6 +167,11 @@ gdk_device_class_init (GdkDeviceClass *klass)
                                                       GDK_SOURCE_MOUSE,
                                                       G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
                                                       G_PARAM_STATIC_STRINGS));
+  /**
+   * GdkDevice:input-mode:
+   *
+   * Input mode for the device.
+   */
   g_object_class_install_property (object_class,
                                    PROP_INPUT_MODE,
 				   g_param_spec_enum ("input-mode",
@@ -144,6 +180,12 @@ gdk_device_class_init (GdkDeviceClass *klass)
                                                       GDK_TYPE_INPUT_MODE,
                                                       GDK_MODE_DISABLED,
                                                       G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+  /**
+   * GdkDevice:has-cursor:
+   *
+   * Whether the device is represented by a cursor on the screen. Devices of type
+   * %GDK_DEVICE_TYPE_MASTER will have %TRUE here.
+   */
   g_object_class_install_property (object_class,
 				   PROP_HAS_CURSOR,
 				   g_param_spec_boolean ("has-cursor",
@@ -152,6 +194,11 @@ gdk_device_class_init (GdkDeviceClass *klass)
                                                          FALSE,
                                                          G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
                                                          G_PARAM_STATIC_STRINGS));
+  /**
+   * GdkDevice:n-axes:
+   *
+   * Number of axes in the device.
+   */
   g_object_class_install_property (object_class,
 				   PROP_N_AXES,
 				   g_param_spec_uint ("n-axes",



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