From 10496d32d77078782f402b8fea831f777faf7512 Mon Sep 17 00:00:00 2001
From: Zaheer Abbas Merali <zaheerabbas@merali.org>
Date: Fri, 31 Mar 2006 16:32:47 +0000
Subject: 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
---
 sys/ximagesrc/ximagesrc.c | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

(limited to 'sys/ximagesrc')

diff --git a/sys/ximagesrc/ximagesrc.c b/sys/ximagesrc/ximagesrc.c
index 94b131c2..2edbfd74 100644
--- 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
-- 
cgit v1.2.1