Merge branch 'lukeshu/doc-conversion' into 'main'

docs: Fix mistakes from the GTK-Doc to GI-DocGen conversion

See merge request GNOME/glib!4187

gio/gdbusintrospection.c

@@ -1747,7 +1747,7 @@ parser_error (GMarkupParseContext *context,
  * Parses @xml_data and returns a #GDBusNodeInfo representing the data.
  *
  * The introspection XML must contain exactly one top-level
- * <node> element.
+ * `<node>` element.
  *
  * Note that this routine is using a
  * [GMarkup][glib-Simple-XML-Subset-Parser.description]-based

gio/gioenums.h

@@ -290,8 +290,8 @@ typedef enum /*< flags >*/ {
  *    assemble/disassemble a virtual drive from several physical
  *    drives.
  * @G_DRIVE_START_STOP_TYPE_PASSWORD: The start/stop methods will
- *    unlock/lock the disk (for example using the ATA <quote>SECURITY
- *    UNLOCK DEVICE</quote> command)
+ *    unlock/lock the disk (for example using the ATA `SECURITY UNLOCK
+ *    DEVICE` command)
  *
  * Enumeration describing how a drive can be started/stopped.
  *

gio/gproxyresolver.c

@@ -133,7 +133,7 @@ g_proxy_resolver_is_supported (GProxyResolver *resolver)
  * Looks into the system proxy configuration to determine what proxy,
  * if any, to use to connect to @uri. The returned proxy URIs are of
  * the form `<protocol>://[user[:password]@]host[:port]` or
- * `direct://`, where <protocol> could be http, rtsp, socks
+ * `direct://`, where `<protocol>` could be http, rtsp, socks
  * or other proxying protocol.
  *
  * If you don't know what network protocol is being used on the

gio/gsocket.c

@@ -6427,7 +6427,7 @@ g_socket_get_credentials (GSocket   *socket,
  * getsockopt(). (If you need to fetch a  non-integer-valued option,
  * you will need to call getsockopt() directly.)
  *
- * The [<gio/gnetworking.h>][gio-gnetworking.h]
+ * The [`<gio/gnetworking.h>`](networking.html)
  * header pulls in system headers that will define most of the
  * standard/portable socket options. For unusual socket protocols or
  * platform-dependent options, you may need to include additional
@@ -6499,7 +6499,7 @@ g_socket_get_option (GSocket  *socket,
  * setsockopt(). (If you need to set a non-integer-valued option,
  * you will need to call setsockopt() directly.)
  *
- * The [<gio/gnetworking.h>][gio-gnetworking.h]
+ * The [`<gio/gnetworking.h>`](networking.html)
  * header pulls in system headers that will define most of the
  * standard/portable socket options. For unusual socket protocols or
  * platform-dependent options, you may need to include additional

gio/gunixmounts.h

@@ -30,7 +30,7 @@ G_BEGIN_DECLS
 /**
  * GUnixMountEntry:
  *
- * Defines a Unix mount entry (e.g. <filename>/media/cdrom</filename>).
+ * Defines a Unix mount entry (e.g. `/media/cdrom`).
  * This corresponds roughly to a mtab entry.
  **/
 typedef struct _GUnixMountEntry GUnixMountEntry;
@@ -42,7 +42,7 @@ GType g_unix_mount_entry_get_type (void) G_GNUC_CONST;
 /**
  * GUnixMountPoint:
  *
- * Defines a Unix mount point (e.g. <filename>/dev</filename>).
+ * Defines a Unix mount point (e.g. `/dev`).
  * This corresponds roughly to a fstab entry.
  **/
 typedef struct _GUnixMountPoint GUnixMountPoint;

glib/deprecated/gthread-deprecated.c

@@ -158,15 +158,17 @@ gboolean         g_threads_got_initialized = TRUE;
  * Since version 2.32, GLib does not support custom thread implementations
  * anymore and the @vtable parameter is ignored and you should pass %NULL.
  *
- * <note><para>g_thread_init() must not be called directly or indirectly
- * in a callback from GLib. Also no mutexes may be currently locked while
- * calling g_thread_init().</para></note>
+ * ::: note
+ *     g_thread_init() must not be called directly or indirectly in a
+ *     callback from GLib. Also no mutexes may be currently locked
+ *     while calling g_thread_init().
  *
- * <note><para>To use g_thread_init() in your program, you have to link
- * with the libraries that the command <command>pkg-config --libs
- * gthread-2.0</command> outputs. This is not the case for all the
- * other thread-related functions of GLib. Those can be used without
- * having to link with the thread libraries.</para></note>
+ * ::: note
+ *     To use g_thread_init() in your program, you have to link with
+ *     the libraries that the command `pkg-config --libs gthread-2.0`
+ *     outputs. This is not the case for all the other thread-related
+ *     functions of GLib. Those can be used without having to link
+ *     with the thread libraries.
  *
  * Deprecated:2.32: This function is no longer necessary. The GLib
  *     threading system is automatically initialized at the start

glib/gdatetime.c

@@ -1495,7 +1495,7 @@ parse_iso8601_time (const gchar *text, gsize length,
  *
  * Creates a #GDateTime corresponding to the given
  * [ISO 8601 formatted string](https://en.wikipedia.org/wiki/ISO_8601)
- * @text. ISO 8601 strings of the form <date><sep><time><tz> are supported, with
+ * @text. ISO 8601 strings of the form `<date><sep><time><tz>` are supported, with
  * some extensions from [RFC 3339](https://tools.ietf.org/html/rfc3339) as
  * mentioned below.
  *
@@ -1503,11 +1503,11 @@ parse_iso8601_time (const gchar *text, gsize length,
  * in an ISO-8601 string will be ignored, so a `23:59:60` time would be parsed as
  * `23:59:59`.
  *
- * <sep> is the separator and can be either 'T', 't' or ' '. The latter two
+ * `<sep>` is the separator and can be either 'T', 't' or ' '. The latter two
  * separators are an extension from
  * [RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6).
  *
- * <date> is in the form:
+ * `<date>` is in the form:
  *
  * - `YYYY-MM-DD` - Year/month/day, e.g. 2016-08-24.
  * - `YYYYMMDD` - Same as above without dividers.
@@ -1517,12 +1517,12 @@ parse_iso8601_time (const gchar *text, gsize length,
  *   e.g. 2016-W34-3.
  * - `YYYYWwwD` - Same as above without dividers.
  *
- * <time> is in the form:
+ * `<time>` is in the form:
  *
  * - `hh:mm:ss(.sss)` - Hours, minutes, seconds (subseconds), e.g. 22:10:42.123.
  * - `hhmmss(.sss)` - Same as above without dividers.
  *
- * <tz> is an optional timezone suffix of the form:
+ * `<tz>` is an optional timezone suffix of the form:
  *
  * - `Z` - UTC.
  * - `+hh:mm` or `-hh:mm` - Offset from UTC in hours and minutes, e.g. +12:00.

glib/gregex.c

@@ -1540,7 +1540,7 @@ get_matched_substring_number (const GMatchInfo *match_info,
  * Retrieves the text matching the capturing parentheses named @name.
  *
  * If @name is a valid sub pattern name but it didn't match anything
- * (e.g. sub pattern "X", matching "b" against "(?P<X>a)?b")
+ * (e.g. sub pattern `"X"`, matching `"b"` against `"(?P<X>a)?b"`)
  * then an empty string is returned.
  *
  * The string is fetched from the string passed to the match function,
@@ -1579,7 +1579,7 @@ g_match_info_fetch_named (const GMatchInfo *match_info,
  * Retrieves the position in bytes of the capturing parentheses named @name.
  *
  * If @name is a valid sub pattern name but it didn't match anything
- * (e.g. sub pattern "X", matching "b" against "(?P<X>a)?b")
+ * (e.g. sub pattern `"X"`, matching `"b"` against `"(?P<X>a)?b"`)
  * then @start_pos and @end_pos are set to -1 and %TRUE is returned.
  *
  * Returns: %TRUE if the position was fetched, %FALSE otherwise.
@@ -2351,15 +2351,15 @@ g_regex_match_all (const GRegex      *regex,
  * Using the standard algorithm for regular expression matching only
  * the longest match in the @string is retrieved, it is not possible
  * to obtain all the available matches. For instance matching
- * "<a> <b> <c>" against the pattern "<.*>"
- * you get "<a> <b> <c>".
+ * `"<a> <b> <c>"` against the pattern `"<.*>"`
+ * you get `"<a> <b> <c>"`.
  *
  * This function uses a different algorithm (called DFA, i.e. deterministic
  * finite automaton), so it can retrieve all the possible matches, all
  * starting at the same point in the string. For instance matching
- * "<a> <b> <c>" against the pattern "<.*>;"
- * you would obtain three matches: "<a> <b> <c>",
- * "<a> <b>" and "<a>".
+ * `"<a> <b> <c>"` against the pattern `"<.*>"`
+ * you would obtain three matches: `"<a> <b> <c>"`,
+ * `"<a> <b>"` and `"<a>"`.
  *
  * The number of matched strings is retrieved using
  * g_match_info_get_match_count(). To obtain the matched strings and
@@ -3265,13 +3265,13 @@ interpolation_list_needs_match (GList *list)
  * @error: location to store the error occurring, or %NULL to ignore errors
  *
  * Replaces all occurrences of the pattern in @regex with the
- * replacement text. Backreferences of the form '\number' or
- * '\g<number>' in the replacement text are interpolated by the
- * number-th captured subexpression of the match, '\g<name>' refers
- * to the captured subexpression with the given name. '\0' refers
- * to the complete match, but '\0' followed by a number is the octal
- * representation of a character. To include a literal '\' in the
- * replacement, write '\\\\'.
+ * replacement text. Backreferences of the form `\number` or
+ * `\g<number>` in the replacement text are interpolated by the
+ * number-th captured subexpression of the match, `\g<name>` refers
+ * to the captured subexpression with the given name. `\0` refers
+ * to the complete match, but `\0` followed by a number is the octal
+ * representation of a character. To include a literal `\` in the
+ * replacement, write `\\\\`.
  *
  * There are also escapes that changes the case of the following text:
  *