From 972615cf220f63acba35cc62048bb7ec4fbdb720 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Tim-Philipp=20M=C3=BCller?= Date: Thu, 11 Nov 2021 19:11:25 +0000 Subject: [PATCH] docs: fix unnecessary ampersand, < and > escaping in code blocks Part-of: --- subprojects/gst-editing-services/ges/ges-multi-file-source.c | 2 +- subprojects/gst-plugins-bad/ext/rsvg/gstrsvgoverlay.c | 2 +- .../gst-libs/gst/basecamerabinsrc/gstbasecamerasrc.c | 8 ++++---- .../gst-libs/gst/pbutils/gstpluginsbaseversion.c | 2 +- .../gst-plugins-base/gst-libs/gst/pbutils/install-plugins.c | 6 +++--- .../gst-plugins-base/gst-libs/gst/video/video-frame.c | 4 ++-- .../gst-plugins-base/gst-libs/gst/video/videooverlay.c | 8 ++++---- subprojects/gst-plugins-good/ext/cairo/gstcairooverlay.c | 12 ++++++------ .../gst-plugins-good/gst/equalizer/gstiirequalizernbands.c | 4 ++-- subprojects/gstreamer/gst/gst.c | 2 +- subprojects/gstreamer/gst/gstelementfactory.c | 4 ++-- subprojects/gstreamer/gst/gstinfo.c | 2 +- subprojects/gstreamer/gst/gstiterator.c | 6 +++--- subprojects/gstreamer/gst/gstmessage.c | 6 +++--- subprojects/gstreamer/gst/gstpadtemplate.c | 4 ++-- subprojects/gstreamer/gst/gstquery.c | 2 +- subprojects/gstreamer/gst/gsttypefindfactory.c | 10 +++++----- subprojects/gstreamer/libs/gst/base/gstbasesink.c | 2 +- subprojects/gstreamer/libs/gst/base/gstbasesrc.c | 2 +- 19 files changed, 44 insertions(+), 44 deletions(-) diff --git a/subprojects/gst-editing-services/ges/ges-multi-file-source.c b/subprojects/gst-editing-services/ges/ges-multi-file-source.c index 25f600f..154cd65 100644 --- a/subprojects/gst-editing-services/ges/ges-multi-file-source.c +++ b/subprojects/gst-editing-services/ges/ges-multi-file-source.c @@ -241,7 +241,7 @@ ges_multi_file_source_class_init (GESMultiFileSourceClass * klass) * * The uri of the file/resource to use. You can set a start index, * a stop index and a sequence pattern. - * The format is <multifile://start:stop\@location-pattern>. + * The format is . * The pattern uses printf string formating. * * Example uris: diff --git a/subprojects/gst-plugins-bad/ext/rsvg/gstrsvgoverlay.c b/subprojects/gst-plugins-bad/ext/rsvg/gstrsvgoverlay.c index 7ab7725..5d890e0 100644 --- a/subprojects/gst-plugins-bad/ext/rsvg/gstrsvgoverlay.c +++ b/subprojects/gst-plugins-bad/ext/rsvg/gstrsvgoverlay.c @@ -53,7 +53,7 @@ * gst-launch-1.0 -v videotestsrc ! videoconvert ! rsvgoverlay name=overlay ! videoconvert ! autovideosink filesrc location=foo.svg ! image/svg ! overlay.data_sink * ]| does the same by feeding data through the data_sink pad. You can also specify the SVG data itself as parameter: * |[ - * gst-launch-1.0 -v videotestsrc ! videoconvert ! rsvgoverlay data='<svg viewBox="0 0 800 600"><image x="80%" y="80%" width="10%" height="10%" xlink:href="foo.jpg" /></svg>' ! videoconvert ! autovideosink + * gst-launch-1.0 -v videotestsrc ! videoconvert ! rsvgoverlay data='' ! videoconvert ! autovideosink * ]| * */ diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/basecamerabinsrc/gstbasecamerasrc.c b/subprojects/gst-plugins-bad/gst-libs/gst/basecamerabinsrc/gstbasecamerasrc.c index 59d5e8b..0639f10 100644 --- a/subprojects/gst-plugins-bad/gst-libs/gst/basecamerabinsrc/gstbasecamerasrc.c +++ b/subprojects/gst-plugins-bad/gst-libs/gst/basecamerabinsrc/gstbasecamerasrc.c @@ -46,13 +46,13 @@ * // pad templates should be a #GstStaticPadTemplate with direction * // #GST_PAD_SRC and name "vidsrc", "imgsrc" and "vfsrc" * gst_element_class_add_static_pad_template (gstelement_class, - * &vidsrc_template); + * &vidsrc_template); * gst_element_class_add_static_pad_template (gstelement_class, - * &imgsrc_template); + * &imgsrc_template); * gst_element_class_add_static_pad_template (gstelement_class, - * &vfsrc_template); + * &vfsrc_template); * // see #GstElementDetails - * gst_element_class_set_details (gstelement_class, &details); + * gst_element_class_set_details (gstelement_class, &details); * } * ]| * diff --git a/subprojects/gst-plugins-base/gst-libs/gst/pbutils/gstpluginsbaseversion.c b/subprojects/gst-plugins-base/gst-libs/gst/pbutils/gstpluginsbaseversion.c index d4075b2..9d8337b 100644 --- a/subprojects/gst-plugins-base/gst-libs/gst/pbutils/gstpluginsbaseversion.c +++ b/subprojects/gst-plugins-base/gst-libs/gst/pbutils/gstpluginsbaseversion.c @@ -27,7 +27,7 @@ * if you need to check at runtime what version of the gst-plugins-base * libraries are being used / you are currently linked against. * - * The version macros get defined by including <gst/pbutils/pbutils.h>. + * The version macros get defined by including . */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/subprojects/gst-plugins-base/gst-libs/gst/pbutils/install-plugins.c b/subprojects/gst-plugins-base/gst-libs/gst/pbutils/install-plugins.c index 429043a..4853f32 100644 --- a/subprojects/gst-plugins-base/gst-libs/gst/pbutils/install-plugins.c +++ b/subprojects/gst-plugins-base/gst-libs/gst/pbutils/install-plugins.c @@ -392,13 +392,13 @@ void gst_install_plugins_context_set_startup_notification_id * Gtk+/Gnome application should be able to obtain the XID of the top-level * window like this: * |[ - * ##include <gtk/gtk.h> + * ##include * ##ifdef GDK_WINDOWING_X11 - * ##include <gdk/gdkx.h> + * ##include * ##endif * ... * ##ifdef GDK_WINDOWING_X11 - * xid = GDK_WINDOW_XWINDOW (GTK_WIDGET (application_window)->window); + * xid = GDK_WINDOW_XWINDOW (GTK_WIDGET (application_window)->window); * ##endif * ... * ]| diff --git a/subprojects/gst-plugins-base/gst-libs/gst/video/video-frame.c b/subprojects/gst-plugins-base/gst-libs/gst/video/video-frame.c index a4f7365..0b23989 100644 --- a/subprojects/gst-plugins-base/gst-libs/gst/video/video-frame.c +++ b/subprojects/gst-plugins-base/gst-libs/gst/video/video-frame.c @@ -206,7 +206,7 @@ invalid_size: * GstVideoFrame vframe; * ... * // set RGB pixels to black one at a time - * if (gst_video_frame_map (&vframe, video_info, video_buffer, GST_MAP_WRITE)) { + * if (gst_video_frame_map (&vframe, video_info, video_buffer, GST_MAP_WRITE)) { * guint8 *pixels = GST_VIDEO_FRAME_PLANE_DATA (vframe, 0); * guint stride = GST_VIDEO_FRAME_PLANE_STRIDE (vframe, 0); * guint pixel_stride = GST_VIDEO_FRAME_COMP_PSTRIDE (vframe, 0); @@ -219,7 +219,7 @@ invalid_size: * } * } * - * gst_video_frame_unmap (&vframe); + * gst_video_frame_unmap (&vframe); * } * ... * ]| diff --git a/subprojects/gst-plugins-base/gst-libs/gst/video/videooverlay.c b/subprojects/gst-plugins-base/gst-libs/gst/video/videooverlay.c index e1465ba..8bac025 100644 --- a/subprojects/gst-plugins-base/gst-libs/gst/video/videooverlay.c +++ b/subprojects/gst-plugins-base/gst-libs/gst/video/videooverlay.c @@ -127,13 +127,13 @@ * ## GstVideoOverlay and Gtk+ * * |[ - * #include <gst/video/videooverlay.h> - * #include <gtk/gtk.h> + * #include + * #include * #ifdef GDK_WINDOWING_X11 - * #include <gdk/gdkx.h> // for GDK_WINDOW_XID + * #include // for GDK_WINDOW_XID * #endif * #ifdef GDK_WINDOWING_WIN32 - * #include <gdk/gdkwin32.h> // for GDK_WINDOW_HWND + * #include // for GDK_WINDOW_HWND * #endif * ... * static guintptr video_window_handle = 0; diff --git a/subprojects/gst-plugins-good/ext/cairo/gstcairooverlay.c b/subprojects/gst-plugins-good/ext/cairo/gstcairooverlay.c index 789ce27..7ecdf49 100644 --- a/subprojects/gst-plugins-good/ext/cairo/gstcairooverlay.c +++ b/subprojects/gst-plugins-good/ext/cairo/gstcairooverlay.c @@ -28,8 +28,8 @@ * ## Example code * |[ * - * #include <gst/gst.h> - * #include <gst/video/video.h> + * #include + * #include * * ... * @@ -46,8 +46,8 @@ * { * CairoOverlayState *state = (CairoOverlayState *)user_data; * - * gst_video_format_parse_caps (caps, NULL, &state->width, &state->height); - * state->valid = TRUE; + * gst_video_format_parse_caps (caps, NULL, &state->width, &state->height); + * state->valid = TRUE; * } * * static void @@ -57,11 +57,11 @@ * CairoOverlayState *s = (CairoOverlayState *)user_data; * double scale; * - * if (!s->valid) + * if (!s->valid) * return; * * scale = 2*(((timestamp/(int)1e7) % 70)+30)/100.0; - * cairo_translate(cr, s->width/2, (s->height/2)-30); + * cairo_translate(cr, s->width/2, (s->height/2)-30); * cairo_scale (cr, scale, scale); * * cairo_move_to (cr, 0, 0); diff --git a/subprojects/gst-plugins-good/gst/equalizer/gstiirequalizernbands.c b/subprojects/gst-plugins-good/gst/equalizer/gstiirequalizernbands.c index 2f9f9a4..f772664 100644 --- a/subprojects/gst-plugins-good/gst/equalizer/gstiirequalizernbands.c +++ b/subprojects/gst-plugins-good/gst/equalizer/gstiirequalizernbands.c @@ -33,7 +33,7 @@ * * ## Example code * |[ - * #include <gst/gst.h> + * #include * * ... * typedef struct { @@ -62,7 +62,7 @@ * * ... * - * for (i = 0; i < 5; i++) { + * for (i = 0; i < 5; i++) { * band = gst_child_proxy_get_child_by_index (GST_CHILD_PROXY (equalizer), i); * g_object_set (G_OBJECT (band), "freq", state[i].freq, * "bandwidth", state[i].width, diff --git a/subprojects/gstreamer/gst/gst.c b/subprojects/gstreamer/gst/gst.c index 7f2e993..a3b5897 100644 --- a/subprojects/gstreamer/gst/gst.c +++ b/subprojects/gstreamer/gst/gst.c @@ -73,7 +73,7 @@ * main (int argc, char *argv[]) * { * GOptionEntry options[] = { - * {"tags", 't', 0, G_OPTION_ARG_NONE, &tags, + * {"tags", 't', 0, G_OPTION_ARG_NONE, &tags, * N_("Output tags (also known as metadata)"), NULL}, * {NULL} * }; diff --git a/subprojects/gstreamer/gst/gstelementfactory.c b/subprojects/gstreamer/gst/gstelementfactory.c index cd84130..a36a54f 100644 --- a/subprojects/gstreamer/gst/gstelementfactory.c +++ b/subprojects/gstreamer/gst/gstelementfactory.c @@ -39,12 +39,12 @@ * * ## Using an element factory * |[ - * #include <gst/gst.h> + * #include * * GstElement *src; * GstElementFactory *srcfactory; * - * gst_init (&argc, &argv); + * gst_init (&argc, &argv); * * srcfactory = gst_element_factory_find ("filesrc"); * g_return_if_fail (srcfactory != NULL); diff --git a/subprojects/gstreamer/gst/gstinfo.c b/subprojects/gstreamer/gst/gstinfo.c index bb5979c..66eb50b 100644 --- a/subprojects/gstreamer/gst/gstinfo.c +++ b/subprojects/gstreamer/gst/gstinfo.c @@ -73,7 +73,7 @@ * If you must do that for some reason, there is still an option. * If the debugging * subsystem was compiled out, GST_DISABLE_GST_DEBUG is defined in - * <gst/gst.h>, + * , * so you can check that before doing your trick. * Disabling the debugging subsystem will give you a slight (read: unnoticeable) * speed increase and will reduce the size of your compiled code. The GStreamer diff --git a/subprojects/gstreamer/gst/gstiterator.c b/subprojects/gstreamer/gst/gstiterator.c index 82847bf..2ffad6b 100644 --- a/subprojects/gstreamer/gst/gstiterator.c +++ b/subprojects/gstreamer/gst/gstiterator.c @@ -44,10 +44,10 @@ * GValue item = G_VALUE_INIT; * done = FALSE; * while (!done) { - * switch (gst_iterator_next (it, &item)) { + * switch (gst_iterator_next (it, &item)) { * case GST_ITERATOR_OK: * ...get/use/change item here... - * g_value_reset (&item); + * g_value_reset (&item); * break; * case GST_ITERATOR_RESYNC: * ...rollback changes to items... @@ -62,7 +62,7 @@ * break; * } * } - * g_value_unset (&item); + * g_value_unset (&item); * gst_iterator_free (it); * ]| */ diff --git a/subprojects/gstreamer/gst/gstmessage.c b/subprojects/gstreamer/gst/gstmessage.c index 45d4f4f..4e6f2be 100644 --- a/subprojects/gstreamer/gst/gstmessage.c +++ b/subprojects/gstreamer/gst/gstmessage.c @@ -1240,7 +1240,7 @@ gst_message_has_name (GstMessage * message, const gchar * name) * case GST_MESSAGE_TAG: { * GstTagList *tags = NULL; * - * gst_message_parse_tag (msg, &tags); + * gst_message_parse_tag (msg, &tags); * g_print ("Got tags from element %s\n", GST_OBJECT_NAME (msg->src)); * handle_tags (tags); * gst_tag_list_unref (tags); @@ -1363,7 +1363,7 @@ gst_message_parse_buffering_stats (GstMessage * message, * case GST_MESSAGE_STATE_CHANGED: { * GstState old_state, new_state; * - * gst_message_parse_state_changed (msg, &old_state, &new_state, NULL); + * gst_message_parse_state_changed (msg, &old_state, &new_state, NULL); * g_print ("Element %s changed state from %s to %s.\n", * GST_OBJECT_NAME (msg->src), * gst_element_state_get_name (old_state), @@ -1551,7 +1551,7 @@ gst_message_parse_structure_change (GstMessage * message, * GError *err = NULL; * gchar *dbg_info = NULL; * - * gst_message_parse_error (msg, &err, &dbg_info); + * gst_message_parse_error (msg, &err, &dbg_info); * g_printerr ("ERROR from element %s: %s\n", * GST_OBJECT_NAME (msg->src), err->message); * g_printerr ("Debugging info: %s\n", (dbg_info) ? dbg_info : "none"); diff --git a/subprojects/gstreamer/gst/gstpadtemplate.c b/subprojects/gstreamer/gst/gstpadtemplate.c index 8055a9a..473aa55 100644 --- a/subprojects/gstreamer/gst/gstpadtemplate.c +++ b/subprojects/gstreamer/gst/gstpadtemplate.c @@ -70,7 +70,7 @@ * my_method (void) * { * GstPad *pad; - * pad = gst_pad_new_from_static_template (&my_template, "sink"); + * pad = gst_pad_new_from_static_template (&my_template, "sink"); * ... * } * ]| @@ -83,7 +83,7 @@ * { * GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass); * - * gst_element_class_add_static_pad_template (gstelement_class, &my_template); + * gst_element_class_add_static_pad_template (gstelement_class, &my_template); * } * ]| */ diff --git a/subprojects/gstreamer/gst/gstquery.c b/subprojects/gstreamer/gst/gstquery.c index db3586c..6ae1f76 100644 --- a/subprojects/gstreamer/gst/gstquery.c +++ b/subprojects/gstreamer/gst/gstquery.c @@ -44,7 +44,7 @@ * res = gst_element_query (pipeline, query); * if (res) { * gint64 duration; - * gst_query_parse_duration (query, NULL, &duration); + * gst_query_parse_duration (query, NULL, &duration); * g_print ("duration = %"GST_TIME_FORMAT, GST_TIME_ARGS (duration)); * } else { * g_print ("duration query failed..."); diff --git a/subprojects/gstreamer/gst/gsttypefindfactory.c b/subprojects/gstreamer/gst/gsttypefindfactory.c index 433b9ad..2aab054 100644 --- a/subprojects/gstreamer/gst/gsttypefindfactory.c +++ b/subprojects/gstreamer/gst/gsttypefindfactory.c @@ -43,7 +43,7 @@ * my_peek (gpointer data, gint64 offset, guint size) * { * MyTypeFind *find = (MyTypeFind *) data; - * if (offset >= 0 && offset + size <= find->size) { + * if (offset >= 0 && offset + size <= find->size) { * return find->data + offset; * } * return NULL; @@ -52,9 +52,9 @@ * my_suggest (gpointer data, guint probability, GstCaps *caps) * { * MyTypeFind *find = (MyTypeFind *) data; - * if (probability > find->probability) { + * if (probability > find->probability) { * find->probability = probability; - * gst_caps_replace (&find->caps, caps); + * gst_caps_replace (&find->caps, caps); * } * } * static GstCaps * @@ -62,12 +62,12 @@ * { * GList *walk, *type_list; * MyTypeFind find = {data, size, 0, NULL}; - * GstTypeFind gst_find = {my_peek, my_suggest, &find, }; + * GstTypeFind gst_find = {my_peek, my_suggest, &find, }; * walk = type_list = gst_type_find_factory_get_list (); * while (walk) { * GstTypeFindFactory *factory = GST_TYPE_FIND_FACTORY (walk->data); * walk = g_list_next (walk) - * gst_type_find_factory_call_function (factory, &gst_find); + * gst_type_find_factory_call_function (factory, &gst_find); * } * g_list_free (type_list); * return find.caps; diff --git a/subprojects/gstreamer/libs/gst/base/gstbasesink.c b/subprojects/gstreamer/libs/gst/base/gstbasesink.c index 0a116d6..751986d 100644 --- a/subprojects/gstreamer/libs/gst/base/gstbasesink.c +++ b/subprojects/gstreamer/libs/gst/base/gstbasesink.c @@ -46,7 +46,7 @@ * * // sinktemplate should be a #GstStaticPadTemplate with direction * // %GST_PAD_SINK and name "sink" - * gst_element_class_add_static_pad_template (gstelement_class, &sinktemplate); + * gst_element_class_add_static_pad_template (gstelement_class, &sinktemplate); * * gst_element_class_set_static_metadata (gstelement_class, * "Sink name", diff --git a/subprojects/gstreamer/libs/gst/base/gstbasesrc.c b/subprojects/gstreamer/libs/gst/base/gstbasesrc.c index 2ba04cb..28259f4 100644 --- a/subprojects/gstreamer/libs/gst/base/gstbasesrc.c +++ b/subprojects/gstreamer/libs/gst/base/gstbasesrc.c @@ -109,7 +109,7 @@ * GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass); * // srctemplate should be a #GstStaticPadTemplate with direction * // %GST_PAD_SRC and name "src" - * gst_element_class_add_static_pad_template (gstelement_class, &srctemplate); + * gst_element_class_add_static_pad_template (gstelement_class, &srctemplate); * * gst_element_class_set_static_metadata (gstelement_class, * "Source name", -- 2.7.4