zbar: fix documentation

Fix some typos and markdown cleanup.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/7914>
This commit is contained in:
Stéphane Cerveau 2024-11-18 11:00:36 +01:00 committed by GStreamer Marge Bot
parent 6d8cd9cf92
commit c67ac844ed

View file

@ -22,26 +22,26 @@
* @title: zbar * @title: zbar
* *
* Detect bar codes in the video streams and send them as element messages to * Detect bar codes in the video streams and send them as element messages to
* the #GstBus if .#GstZBar:message property is %TRUE. * the #GstBus if #GstZBar:message property is %TRUE.
* If the .#GstZBar:attach-frame property is %TRUE, the posted barcode message * 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). * includes a sample of the frame where the barcode was detected (Since 1.6).
* *
* The element generate messages named`barcode`. The structure contains these fields: * The element generates messages named `barcode`. The structure contains these fields:
* *
* * #GstClockTime `timestamp`: the timestamp of the buffer that triggered the message. * * #GstClockTime `timestamp`: the timestamp of the buffer that triggered the message.
* * gchar * `type`: the symbol type. * * gchar * `type`: the symbol type.
* * gchar * `symbol`: the detected bar code data. * * gchar * `symbol`: the detected bar code data.
* * gint `quality`: an unscaled, relative quantity: larger values are better than smaller * * gint `quality`: an unscaled, relative quantity: larger values are better than smaller
* values. * values.
* * GstSample `frame`: 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) * the #GstZBar:attach-frame property was set to %TRUE (Since 1.6)
* *
* ## Example launch lines * ## Example launch lines
* |[ * |[
* gst-launch-1.0 -m v4l2src ! videoconvert ! zbar ! videoconvert ! xvimagesink * gst-launch-1.0 -m v4l2src ! videoconvert ! zbar ! videoconvert ! xvimagesink
* ]| This pipeline will detect barcodes and send them as messages. * ]| 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 * gst-launch-1.0 -m v4l2src ! tee name=t ! queue ! videoconvert ! zbar ! fakesink t. ! queue ! videoconvert ! xvimagesink
* ]| Same as above, but running the filter on a branch to keep the display in color * ]| Same as above, but running the filter on a branch to keep the display in color
* *
*/ */