sys/ximagesrc/ximagesrc.c: Add docs to ximagesrc

Original commit message from CVS:
2006-03-31  Zaheer Abbas Merali  <zaheerabbas at merali dot org>

* sys/ximagesrc/ximagesrc.c:
Add docs to ximagesrc

diff --git a/ChangeLog b/ChangeLog
index 809581a9bf28961dc60895274d6d2a68e8966736..8536be48f27cd9b70d947349718082ce221d6f9c 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2006-03-31  Zaheer Abbas Merali  <zaheerabbas at merali dot org>
+
+       * sys/ximagesrc/ximagesrc.c: 
+         Add docs to ximagesrc
+
 2006-03-31  Zaheer Abbas Merali  <zaheerabbas at merali dot org>
 
        * sys/ximagesrc/ximagesrc.c: (composite_pixel),

diff --git a/sys/ximagesrc/ximagesrc.c b/sys/ximagesrc/ximagesrc.c
index 94b131c20d3c251236ee5881b70d745ee342103a..2edbfd744a5ddbde184bc8b4fd9beed64d79ce14 100644 (file)
--- a/sys/ximagesrc/ximagesrc.c
+++ b/sys/ximagesrc/ximagesrc.c
@@ -16,6 +16,31 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-ximagesrc
+ * @short_description: a source that captures your X Display
+ *
+ * <refsect2>
+ * <para>
+ * This element captures your X Display and creates raw RGB video.  It uses
+ * the XDamage extension if available to only capture areas of the screen that
+ * have changed since the last frame.  It uses the XFixes extension if
+ * available to also cpature your mouse pointer
+ * </para>
+ * <title>Example pipelines</title>
+ * <para>
+ * Encode your X display to an Ogg theora video
+ * </para>
+ * <programlisting>
+ * gst-launch -v ximagesrc ! ffmpegcolorspace ! theoraenc ! oggmux ! filesink location=desktop.ogg
+ * </programlisting>
+ * <para>
+ * </refsect2>
+ *
+ */
+
+
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif