From d0b59da656d189e3fa73f310c475d5e7c7906bf3 Mon Sep 17 00:00:00 2001 From: "Luke T. Shumaker" Date: Mon, 12 Aug 2024 17:37:40 -0600 Subject: [PATCH] docs: Transition remaining DocBook XML to markdown/HTML These remaining DocBook tags are mostly harmless; they are passed as HTML5 tags to the browser, which effectively treats them as just elements, so all this mistake is doing is dropping some styling. This lack of of styling can be seen at: - https://docs.gtk.org/gio/enum.DriveStartStopType.html "ATA SECURITY UNLOCK DEVICE" is not indicated to be a quote or anything. - https://docs.gtk.org/gio/struct.UnixMountEntry.html "/media/cdrom" is not rendered in monospace. - https://docs.gtk.org/gio/struct.UnixMountPoint.html "/dev" is not rendered in monospace. - https://docs.gtk.org/glib/type_func.Thread.init.html the notes are not indicated to be anything other than regular paragraphs. Fix that. --- gio/gioenums.h | 4 ++-- gio/gunixmounts.h | 4 ++-- glib/deprecated/gthread-deprecated.c | 18 ++++++++++-------- 3 files changed, 14 insertions(+), 12 deletions(-) diff --git a/gio/gioenums.h b/gio/gioenums.h index 4223253de..f2c60b401 100644 --- a/gio/gioenums.h +++ b/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 SECURITY - * UNLOCK DEVICE command) + * unlock/lock the disk (for example using the ATA `SECURITY UNLOCK + * DEVICE` command) * * Enumeration describing how a drive can be started/stopped. * diff --git a/gio/gunixmounts.h b/gio/gunixmounts.h index 11fc5f6d9..b3595b55a 100644 --- a/gio/gunixmounts.h +++ b/gio/gunixmounts.h @@ -30,7 +30,7 @@ G_BEGIN_DECLS /** * GUnixMountEntry: * - * Defines a Unix mount entry (e.g. /media/cdrom). + * 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. /dev). + * Defines a Unix mount point (e.g. `/dev`). * This corresponds roughly to a fstab entry. **/ typedef struct _GUnixMountPoint GUnixMountPoint; diff --git a/glib/deprecated/gthread-deprecated.c b/glib/deprecated/gthread-deprecated.c index fb281ac51..157a8074d 100644 --- a/glib/deprecated/gthread-deprecated.c +++ b/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. * - * 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 + * 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(). * - * 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. + * ::: 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