sys/ximage/gstximagesrc.c: Document newly-added properties properly, so that there...

Original commit message from CVS:
* sys/ximage/gstximagesrc.c: (gst_ximage_src_class_init):
Document newly-added properties properly, so that there is a
'Since: 0.10.4' in the plugin docs. Convert some property
names into canonical GObject style (GObject will do that
internally anyway).

diff --git a/ChangeLog b/ChangeLog
index 58dca7da1ebf7f529afc80ed5f579eb94e5cb23d..4fead7e9740d494907f781b52ec5b4eb8548d98b 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2006-07-25  Tim-Philipp Müller  <tim at centricular dot net>
+
+       * sys/ximage/gstximagesrc.c: (gst_ximage_src_class_init):
+         Document newly-added properties properly, so that there is a
+         'Since: 0.10.4' in the plugin docs. Convert some property
+         names into canonical GObject style (GObject will do that
+         internally anyway).
+
 2006-07-25  Tim-Philipp Müller  <tim at centricular dot net>
 
        * gst/id3demux/id3tags.c:

diff --git a/sys/ximage/gstximagesrc.c b/sys/ximage/gstximagesrc.c
index 1a184fc60a9e69fd0304880375bee4beabbe0529..720c1e34997f8c1f74815e0da473424edfb9a55c 100644 (file)
--- a/sys/ximage/gstximagesrc.c
+++ b/sys/ximage/gstximagesrc.c
@@ -949,31 +949,70 @@ gst_ximage_src_class_init (GstXImageSrcClass * klass)
   gc->finalize = gst_ximage_src_finalize;
 
   g_object_class_install_property (gc, PROP_DISPLAY_NAME,
-      g_param_spec_string ("display_name", "Display", "X Display Name", NULL,
+      g_param_spec_string ("display-name", "Display", "X Display Name", NULL,
           G_PARAM_READWRITE));
   g_object_class_install_property (gc, PROP_SCREEN_NUM,
-      g_param_spec_uint ("screen_num", "Screen number", "X Screen Number",
+      g_param_spec_uint ("screen-num", "Screen number", "X Screen Number",
           0, G_MAXINT, 0, G_PARAM_READWRITE));
   g_object_class_install_property (gc, PROP_SHOW_POINTER,
-      g_param_spec_boolean ("show_pointer", "Show Mouse Pointer",
+      g_param_spec_boolean ("show-pointer", "Show Mouse Pointer",
           "Show mouse pointer (if XFixes extension enabled)", TRUE,
           G_PARAM_READWRITE));
+  /**
+   * GstXImageSrc:use-damage
+   *
+   * Use XDamage (if the XDamage extension is enabled)
+   *
+   * Since: 0.10.4
+   **/
   g_object_class_install_property (gc, PROP_USE_DAMAGE,
-      g_param_spec_boolean ("use_damage", "Use XDamage",
+      g_param_spec_boolean ("use-damage", "Use XDamage",
           "Use XDamage (if XDamage extension enabled)", TRUE,
           G_PARAM_READWRITE));
+  /**
+   * GstXImageSrc:startx
+   *
+   * X coordinate of top left corner of area to be recorded
+   * (0 for top left of screen)
+   *
+   * Since: 0.10.4
+   **/
   g_object_class_install_property (gc, PROP_STARTX,
       g_param_spec_uint ("startx", "Start X co-ordinate",
           "X coordinate of top left corner of area to be recorded (0 for top left of screen)",
           0, G_MAXINT, 0, G_PARAM_READWRITE));
+  /**
+   * GstXImageSrc:starty
+   *
+   * Y coordinate of top left corner of area to be recorded
+   * (0 for top left of screen)
+   *
+   * Since: 0.10.4
+   **/
   g_object_class_install_property (gc, PROP_STARTY,
       g_param_spec_uint ("starty", "Start Y co-ordinate",
           "Y coordinate of top left corner of area to be recorded (0 for top left of screen)",
           0, G_MAXINT, 0, G_PARAM_READWRITE));
+  /**
+   * GstXImageSrc:endx
+   *
+   * X coordinate of bottom right corner of area to be recorded
+   * (0 for bottom right of screen)
+   *
+   * Since: 0.10.4
+   **/
   g_object_class_install_property (gc, PROP_ENDX,
       g_param_spec_uint ("endx", "End X",
           "X coordinate of bottom right corner of area to be recorded (0 for bottom right of screen)",
           0, G_MAXINT, 0, G_PARAM_READWRITE));
+  /**
+   * GstXImageSrc:endy
+   *
+   * Y coordinate of bottom right corner of area to be recorded
+   * (0 for bottom right of screen)
+   *
+   * Since: 0.10.4
+   **/
   g_object_class_install_property (gc, PROP_ENDY,
       g_param_spec_uint ("endy", "End Y",
           "Y coordinate of bottom right corner of area to be recorded (0 for bottom right of screen)",