summaryrefslogtreecommitdiff
path: root/ext/zbar/gstzbar.c
diff options
context:
space:
mode:
Diffstat (limited to 'ext/zbar/gstzbar.c')
-rw-r--r--ext/zbar/gstzbar.c53
1 files changed, 10 insertions, 43 deletions
diff --git a/ext/zbar/gstzbar.c b/ext/zbar/gstzbar.c
index e84f48c2f..18149eb5e 100644
--- a/ext/zbar/gstzbar.c
+++ b/ext/zbar/gstzbar.c
@@ -19,64 +19,31 @@
/**
* SECTION:element-zbar
+ * @title: zbar
*
* Detect bar codes in the video streams and send them as element messages to
* the #GstBus if .#GstZBar:message property is %TRUE.
* If the .#GstZBar:attach-frame property is %TRUE, the posted barcode message
* includes a sample of the frame where the barcode was detected (Since 1.6).
*
- * The element generate messages named
- * <classname>&quot;barcode&quot;</classname>. The structure containes these
- * fields:
- * <itemizedlist>
- * <listitem>
- * <para>
- * #GstClockTime
- * <classname>&quot;timestamp&quot;</classname>:
- * the timestamp of the buffer that triggered the message.
- * </para>
- * </listitem>
- * <listitem>
- * <para>
- * gchar*
- * <classname>&quot;type&quot;</classname>:
- * the symbol type.
- * </para>
- * </listitem>
- * <listitem>
- * <para>
- * gchar*
- * <classname>&quot;symbol&quot;</classname>:
- * the deteted bar code data.
- * </para>
- * </listitem>
- * <listitem>
- * <para>
- * gint
- * <classname>&quot;quality&quot;</classname>:
- * an unscaled, relative quantity: larger values are better than smaller
+ * The element generate messages named`barcode`. The structure containes these fields:
+ *
+ * * #GstClockTime `timestamp`: the timestamp of the buffer that triggered the message.
+ * * gchar * `type`: the symbol type.
+ * * gchar * `symbol`: the deteted bar code data.
+ * * gint `quality`: an unscaled, relative quantity: larger values are better than smaller
* values.
- * </para>
- * </listitem>
- * <listitem>
- * <para>
- * GstSample
- * <classname>&quot;frame&quot;</classname>:
- * the frame in which the barcode message was detected, if
+ * * GstSample `frame`: the frame in which the barcode message was detected, if
* the .#GstZBar:attach-frame property was set to %TRUE (Since 1.6)
- * </para>
- * </listitem>
- * </itemizedlist>
*
- * <refsect2>
- * <title>Example launch lines</title>
+ * ## Example launch lines
* |[
* gst-launch-1.0 -m v4l2src ! videoconvert ! zbar ! videoconvert ! xvimagesink
* ]| This pipeline will detect barcodes and send them as messages.
* |[
* gst-launch-1.0 -m v4l2src ! tee name=t ! queue ! videoconvert ! zbar ! fakesink t. ! queue ! xvimagesink
* ]| Same as above, but running the filter on a branch to keep the display in color
- * </refsect2>
+ *
*/
#ifdef HAVE_CONFIG_H