docs: fix unnecessary ampersand, < and > escaping in code blocks
authorTim-Philipp Müller <tim@centricular.com>
Thu, 11 Nov 2021 19:11:25 +0000 (19:11 +0000)
committerGStreamer Marge Bot <gitlab-merge-bot@gstreamer-foundation.org>
Fri, 12 Nov 2021 11:39:19 +0000 (11:39 +0000)
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1340>

19 files changed:
subprojects/gst-editing-services/ges/ges-multi-file-source.c
subprojects/gst-plugins-bad/ext/rsvg/gstrsvgoverlay.c
subprojects/gst-plugins-bad/gst-libs/gst/basecamerabinsrc/gstbasecamerasrc.c
subprojects/gst-plugins-base/gst-libs/gst/pbutils/gstpluginsbaseversion.c
subprojects/gst-plugins-base/gst-libs/gst/pbutils/install-plugins.c
subprojects/gst-plugins-base/gst-libs/gst/video/video-frame.c
subprojects/gst-plugins-base/gst-libs/gst/video/videooverlay.c
subprojects/gst-plugins-good/ext/cairo/gstcairooverlay.c
subprojects/gst-plugins-good/gst/equalizer/gstiirequalizernbands.c
subprojects/gstreamer/gst/gst.c
subprojects/gstreamer/gst/gstelementfactory.c
subprojects/gstreamer/gst/gstinfo.c
subprojects/gstreamer/gst/gstiterator.c
subprojects/gstreamer/gst/gstmessage.c
subprojects/gstreamer/gst/gstpadtemplate.c
subprojects/gstreamer/gst/gstquery.c
subprojects/gstreamer/gst/gsttypefindfactory.c
subprojects/gstreamer/libs/gst/base/gstbasesink.c
subprojects/gstreamer/libs/gst/base/gstbasesrc.c

index 25f600f..154cd65 100644 (file)
@@ -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 &lt;multifile://start:stop\@location-pattern&gt;.
+   * The format is <multifile://start:stop\@location-pattern>.
    * The pattern uses printf string formating.
    *
    * Example uris:
index 7ab7725..5d890e0 100644 (file)
@@ -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='&lt;svg viewBox="0 0 800 600"&gt;&lt;image x="80%" y="80%" width="10%" height="10%" xlink:href="foo.jpg" /&gt;&lt;/svg&gt;' ! videoconvert ! autovideosink
+ * 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
  * ]|
  *
  */
index 59d5e8b..0639f10 100644 (file)
  *   // 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,
- *       &amp;vidsrc_template);
+ *       &vidsrc_template);
  *   gst_element_class_add_static_pad_template (gstelement_class,
- *       &amp;imgsrc_template);
+ *       &imgsrc_template);
  *   gst_element_class_add_static_pad_template (gstelement_class,
- *       &amp;vfsrc_template);
+ *       &vfsrc_template);
  *   // see #GstElementDetails
- *   gst_element_class_set_details (gstelement_class, &amp;details);
+ *   gst_element_class_set_details (gstelement_class, &details);
  * }
  * ]|
  *
index d4075b2..9d8337b 100644 (file)
@@ -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 &lt;gst/pbutils/pbutils.h&gt;.
+ * The version macros get defined by including <gst/pbutils/pbutils.h>.
  */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
index 429043a..4853f32 100644 (file)
@@ -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 &lt;gtk/gtk.h&gt;
+ * ##include <gtk/gtk.h>
  * ##ifdef GDK_WINDOWING_X11
- * ##include &lt;gdk/gdkx.h&gt;
+ * ##include <gdk/gdkx.h>
  * ##endif
  * ...
  * ##ifdef GDK_WINDOWING_X11
- *   xid = GDK_WINDOW_XWINDOW (GTK_WIDGET (application_window)-&gt;window);
+ *   xid = GDK_WINDOW_XWINDOW (GTK_WIDGET (application_window)->window);
  * ##endif
  * ...
  * ]|
index a4f7365..0b23989 100644 (file)
@@ -206,7 +206,7 @@ invalid_size:
  *   GstVideoFrame vframe;
  *   ...
  *   // set RGB pixels to black one at a time
- *   if (gst_video_frame_map (&amp;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 (&amp;vframe);
+ *     gst_video_frame_unmap (&vframe);
  *   }
  *   ...
  * ]|
index e1465ba..8bac025 100644 (file)
  * ## GstVideoOverlay and Gtk+
  *
  * |[
- * #include &lt;gst/video/videooverlay.h&gt;
- * #include &lt;gtk/gtk.h&gt;
+ * #include <gst/video/videooverlay.h>
+ * #include <gtk/gtk.h>
  * #ifdef GDK_WINDOWING_X11
- * #include &lt;gdk/gdkx.h&gt;  // for GDK_WINDOW_XID
+ * #include <gdk/gdkx.h>  // for GDK_WINDOW_XID
  * #endif
  * #ifdef GDK_WINDOWING_WIN32
- * #include &lt;gdk/gdkwin32.h&gt;  // for GDK_WINDOW_HWND
+ * #include <gdk/gdkwin32.h>  // for GDK_WINDOW_HWND
  * #endif
  * ...
  * static guintptr video_window_handle = 0;
index 789ce27..7ecdf49 100644 (file)
@@ -28,8 +28,8 @@
  * ## Example code
  * |[
  *
- * #include &lt;gst/gst.h&gt;
- * #include &lt;gst/video/video.h&gt;
+ * #include <gst/gst.h>
+ * #include <gst/video/video.h>
  *
  * ...
  *
@@ -46,8 +46,8 @@
  * {
  *   CairoOverlayState *state = (CairoOverlayState *)user_data;
  *
- *   gst_video_format_parse_caps (caps, NULL, &amp;state-&gt;width, &amp;state-&gt;height);
- *   state-&gt;valid = TRUE;
+ *   gst_video_format_parse_caps (caps, NULL, &state->width, &state->height);
+ *   state->valid = TRUE;
  * }
  *
  * static void
  *   CairoOverlayState *s = (CairoOverlayState *)user_data;
  *   double scale;
  *
- *   if (!s-&gt;valid)
+ *   if (!s->valid)
  *     return;
  *
  *   scale = 2*(((timestamp/(int)1e7) % 70)+30)/100.0;
- *   cairo_translate(cr, s-&gt;width/2, (s-&gt;height/2)-30);
+ *   cairo_translate(cr, s->width/2, (s->height/2)-30);
  *   cairo_scale (cr, scale, scale);
  *
  *   cairo_move_to (cr, 0, 0);
index 2f9f9a4..f772664 100644 (file)
@@ -33,7 +33,7 @@
  *
  * ## Example code
  * |[
- * #include &lt;gst/gst.h&gt;
+ * #include <gst/gst.h>
  *
  * ...
  * typedef struct {
@@ -62,7 +62,7 @@
  *
  * ...
  *
- *   for (i = 0; i &lt; 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,
index 7f2e993..a3b5897 100644 (file)
@@ -73,7 +73,7 @@
  * main (int argc, char *argv[])
  * {
  *  GOptionEntry options[] = {
- *   {"tags", 't', 0, G_OPTION_ARG_NONE, &amp;tags,
+ *   {"tags", 't', 0, G_OPTION_ARG_NONE, &tags,
  *       N_("Output tags (also known as metadata)"), NULL},
  *   {NULL}
  *  };
index cd84130..a36a54f 100644 (file)
  *
  * ## Using an element factory
  * |[<!-- language="C" -->
- *   #include &lt;gst/gst.h&gt;
+ *   #include <gst/gst.h>
  *
  *   GstElement *src;
  *   GstElementFactory *srcfactory;
  *
- *   gst_init (&amp;argc, &amp;argv);
+ *   gst_init (&argc, &argv);
  *
  *   srcfactory = gst_element_factory_find ("filesrc");
  *   g_return_if_fail (srcfactory != NULL);
index bb5979c..66eb50b 100644 (file)
@@ -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
- * &lt;gst/gst.h&gt;,
+ * <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
index 82847bf..2ffad6b 100644 (file)
  *   GValue item = G_VALUE_INIT;
  *   done = FALSE;
  *   while (!done) {
- *     switch (gst_iterator_next (it, &amp;item)) {
+ *     switch (gst_iterator_next (it, &item)) {
  *       case GST_ITERATOR_OK:
  *         ...get/use/change item here...
- *         g_value_reset (&amp;item);
+ *         g_value_reset (&item);
  *         break;
  *       case GST_ITERATOR_RESYNC:
  *         ...rollback changes to items...
@@ -62,7 +62,7 @@
  *         break;
  *     }
  *   }
- *   g_value_unset (&amp;item);
+ *   g_value_unset (&item);
  *   gst_iterator_free (it);
  * ]|
  */
index 45d4f4f..4e6f2be 100644 (file)
@@ -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, &amp;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, &amp;old_state, &amp;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, &amp;err, &amp;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");
index 8055a9a..473aa55 100644 (file)
@@ -70,7 +70,7 @@
  *   my_method (void)
  *   {
  *     GstPad *pad;
- *     pad = gst_pad_new_from_static_template (&amp;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, &amp;my_template);
+ *     gst_element_class_add_static_pad_template (gstelement_class, &my_template);
  *   }
  * ]|
  */
index db3586c..6ae1f76 100644 (file)
@@ -44,7 +44,7 @@
  *   res = gst_element_query (pipeline, query);
  *   if (res) {
  *     gint64 duration;
- *     gst_query_parse_duration (query, NULL, &amp;duration);
+ *     gst_query_parse_duration (query, NULL, &duration);
  *     g_print ("duration = %"GST_TIME_FORMAT, GST_TIME_ARGS (duration));
  *   } else {
  *     g_print ("duration query failed...");
index 433b9ad..2aab054 100644 (file)
@@ -43,7 +43,7 @@
  *   my_peek (gpointer data, gint64 offset, guint size)
  *   {
  *     MyTypeFind *find = (MyTypeFind *) data;
- *     if (offset &gt;= 0 &amp;&amp; offset + size &lt;= 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 &gt; find->probability) {
+ *     if (probability > find->probability) {
  *       find->probability = probability;
- *       gst_caps_replace (&amp;find->caps, caps);
+ *       gst_caps_replace (&find->caps, caps);
  *     }
  *   }
  *   static GstCaps *
  *   {
  *     GList *walk, *type_list;
  *     MyTypeFind find = {data, size, 0, NULL};
- *     GstTypeFind gst_find = {my_peek, my_suggest, &amp;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, &amp;gst_find);
+ *       gst_type_find_factory_call_function (factory, &gst_find);
  *     }
  *     g_list_free (type_list);
  *     return find.caps;
index 0a116d6..751986d 100644 (file)
@@ -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, &amp;sinktemplate);
+ *   gst_element_class_add_static_pad_template (gstelement_class, &sinktemplate);
  *
  *   gst_element_class_set_static_metadata (gstelement_class,
  *       "Sink name",
index 2ba04cb..28259f4 100644 (file)
  *   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, &amp;srctemplate);
+ *   gst_element_class_add_static_pad_template (gstelement_class, &srctemplate);
  *
  *   gst_element_class_set_static_metadata (gstelement_class,
  *      "Source name",