From b79a522ddf4c80a3efec4c7a54f96af519620e8b Mon Sep 17 00:00:00 2001
From: Edgard Lima <edgard.lima@indt.org.br>
Date: Mon, 17 Apr 2006 19:43:32 +0000
Subject: Just added a gtk-doc comment.

Original commit message from CVS:
Just added a gtk-doc comment.
---
 sys/v4l2/gstv4l2src.c | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'sys/v4l2/gstv4l2src.c')

diff --git a/sys/v4l2/gstv4l2src.c b/sys/v4l2/gstv4l2src.c
index 35a68bad..9a881d36 100644
--- a/sys/v4l2/gstv4l2src.c
+++ b/sys/v4l2/gstv4l2src.c
@@ -20,6 +20,27 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:element-v4l2srcsrc
+ *
+ * <refsect2>
+ * v4l2src can be used to capture video from v4l2 devices, like webcams and tv cards.
+ * <title>Example launch line</title>
+ * <para>
+ * <programlisting>
+ * gst-launch v4l2src ! xvimagesink
+ * </programlisting>
+ * This pipeline shows the video captured from /dev/video0 tv card.
+ * </para>
+ * <para>
+ * <programlisting>
+ * gst-launch v4l2src use-fixed-fps=true ! xvimagesink
+ * </programlisting>
+ * This exemplo should be used to capture from web-cams
+ * </para>
+ * </refsect2>
+ */
+
 #ifdef HAVE_CONFIG_H
 #include <config.h>
 #endif
-- 
cgit v1.2.1