luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 06:56:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix some backslash escaping issues in doc comments

Browse Source 
None of these comments have been ported to gi-docgen format properly
yet, but let’s at least fix the backslash escaping so that
`G_DIR_SEPARATOR_S` can be documented usefully.

A full port of this file to gi-docgen format can happen in future.

Spotted on
https://discourse.gnome.org/t/escaped-char-in-glib-dir-separator-s-doc/25607.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
This commit is contained in:
Philip Withnall 2024-12-12 13:52:11 +00:00
parent ad3e0a6597
commit 553b026aa5
No known key found for this signature in database
GPG Key ID: C5C42CFB268637CA
1 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
glib/docs.c
View File

@ -856,25 +856,25 @@
* G_OS_WIN32:
*
* This macro is defined only on Windows. So you can bracket
* Windows-specific code in "\#ifdef G_OS_WIN32".
* Windows-specific code in `#ifdef G_OS_WIN32`.
*/
/**
* G_OS_UNIX:
*
* This macro is defined only on UNIX. So you can bracket
* UNIX-specific code in "\#ifdef G_OS_UNIX".
* UNIX-specific code in `#ifdef G_OS_UNIX`.
*
* To detect whether to compile features that require a specific kernel
* or operating system, check for the appropriate OS-specific predefined
* macros instead, for example:
*
* - Linux kernel (any libc, including glibc, musl or Android): `\#ifdef __linux__`
* - Linux kernel and GNU user-space: `\#if defined(__linux__) && defined(__GLIBC__)`
* - FreeBSD kernel (any libc, including glibc): `\#ifdef __FreeBSD_kernel__`
* - FreeBSD kernel and user-space: `\#ifdef __FreeBSD__`
* - Linux kernel (any libc, including glibc, musl or Android): `#ifdef __linux__`
* - Linux kernel and GNU user-space: `#if defined(__linux__) && defined(__GLIBC__)`
* - FreeBSD kernel (any libc, including glibc): `#ifdef __FreeBSD_kernel__`
* - FreeBSD kernel and user-space: `#ifdef __FreeBSD__`
* - Apple operating systems (macOS, iOS, tvOS), regardless of whether
* Cocoa/Carbon toolkits are available: `\#ifdef __APPLE__`
* Cocoa/Carbon toolkits are available: `#ifdef __APPLE__`
*
* See <https://sourceforge.net/p/predef/wiki/OperatingSystems/> for more.
*/
@ -883,23 +883,26 @@
* G_DIR_SEPARATOR:
*
* The directory separator character.
* This is '/' on UNIX machines and '\' under Windows.
*
* This is `'/'` on UNIX machines and `'\'` under Windows.
*/
/**
* G_DIR_SEPARATOR_S:
*
* The directory separator as a string.
* This is "/" on UNIX machines and "\" under Windows.
*
* This is `"/"` on UNIX machines and `"\"` under Windows.
*/
/**
* G_IS_DIR_SEPARATOR:
* @c: a character
*
* Checks whether a character is a directory
* separator. It returns %TRUE for '/' on UNIX
* machines and for '\' or '/' under Windows.
* Checks whether a character is a directory separator.
*
* It returns true for `'/'` on UNIX machines and for `'\'` or `'/'` under
* Windows.
*
* Since: 2.6
*/