ximagesink: Add docs for the new property
authorSebastian Dröge <sebastian.droege@collabora.co.uk>
Mon, 25 Oct 2010 13:13:16 +0000 (14:13 +0100)
committerSebastian Dröge <sebastian.droege@collabora.co.uk>
Thu, 2 Dec 2010 18:04:28 +0000 (19:04 +0100)
Including Since markers

sys/ximage/ximagesink.c

index e014aab..d1780fc 100644 (file)
@@ -2407,13 +2407,29 @@ gst_ximagesink_class_init (GstXImageSinkClass * klass)
           "When enabled, "
           "the current frame will always be drawn in response to X Expose "
           "events", TRUE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+
+  /**
+   * GstXImageSink:window-width
+   *
+   * Actual width of the video window.
+   *
+   * Since: 0.10.32
+   */
   g_object_class_install_property (gobject_class, PROP_WINDOW_WIDTH,
       g_param_spec_uint64 ("window-width", "window-width",
-          "Width of the screen", 0, G_MAXUINT64, 0,
+          "Width of the window", 0, G_MAXUINT64, 0,
           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
+
+  /**
+   * GstXImageSink:window-height
+   *
+   * Actual height of the video window.
+   *
+   * Since: 0.10.32
+   */
   g_object_class_install_property (gobject_class, PROP_WINDOW_HEIGHT,
       g_param_spec_uint64 ("window-height", "window-height",
-          "Height of the screen", 0, G_MAXUINT64, 0,
+          "Height of the window", 0, G_MAXUINT64, 0,
           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 
   gstelement_class->change_state = gst_ximagesink_change_state;