summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEdgard Lima <edgard.lima@indt.org.br>2006-04-17 19:43:32 +0000
committerEdgard Lima <edgard.lima@indt.org.br>2006-04-17 19:43:32 +0000
commitb79a522ddf4c80a3efec4c7a54f96af519620e8b (patch)
treec7cb66d06407f6830e3ff646c76cbf7ea9046297
parentd5ecfe3ca92740168c74d787df12d1eb974bf9e2 (diff)
downloadgst-plugins-bad-b79a522ddf4c80a3efec4c7a54f96af519620e8b.tar.gz
gst-plugins-bad-b79a522ddf4c80a3efec4c7a54f96af519620e8b.tar.bz2
gst-plugins-bad-b79a522ddf4c80a3efec4c7a54f96af519620e8b.zip
Just added a gtk-doc comment.
Original commit message from CVS: Just added a gtk-doc comment.
-rw-r--r--ChangeLog5
-rw-r--r--sys/v4l2/gstv4l2src.c21
2 files changed, 26 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index bc4cd5ce..aa16956f 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2006-04-13 Edgard Lima <edgard.lima@indt.org.br>
+
+ * sys/v4l2/gstv4l2src.c:
+ Just added a gtk-doc comment.
+
2006-04-17 Michael Smith <msmith@fluendo.com>
* ext/theora/theoradec.c: (theora_dec_src_convert),
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