From f62efef1137b2ae91d900f20e9c19c47681e8aaf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim-Philipp=20M=C3=BCller?= Date: Tue, 25 Jul 2006 17:54:25 +0000 Subject: [PATCH] sys/ximage/gstximagesrc.c: Document newly-added properties properly, so that there is a 'Since: 0.10.4' in the plugin... 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). --- ChangeLog | 8 +++++++ sys/ximage/gstximagesrc.c | 47 +++++++++++++++++++++++++++++++++++---- 2 files changed, 51 insertions(+), 4 deletions(-) diff --git a/ChangeLog b/ChangeLog index 58dca7da1e..4fead7e974 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2006-07-25 Tim-Philipp Müller + + * 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 * gst/id3demux/id3tags.c: diff --git a/sys/ximage/gstximagesrc.c b/sys/ximage/gstximagesrc.c index 1a184fc60a..720c1e3499 100644 --- 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)",