luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-11 23:16:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Transition remaining DocBook XML to markdown/HTML

Browse Source 
These remaining DocBook tags are mostly harmless; they are passed as
HTML5 tags to the browser, which effectively treats them as just
<span> 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.
This commit is contained in:
Luke T. Shumaker 2024-08-12 17:37:40 -06:00
parent 0b64bb2204
commit d0b59da656
3 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
gio/gioenums.h
View File

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

4
gio/gunixmounts.h
View File

@ -30,7 +30,7 @@ G_BEGIN_DECLS
/** /**
* GUnixMountEntry: * 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. * This corresponds roughly to a mtab entry.
**/ **/
typedef struct _GUnixMountEntry GUnixMountEntry; typedef struct _GUnixMountEntry GUnixMountEntry;
@ -42,7 +42,7 @@ GType g_unix_mount_entry_get_type (void) G_GNUC_CONST;
/** /**
* GUnixMountPoint: * 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. * This corresponds roughly to a fstab entry.
**/ **/
typedef struct _GUnixMountPoint GUnixMountPoint; typedef struct _GUnixMountPoint GUnixMountPoint;

18
glib/deprecated/gthread-deprecated.c
View File

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