luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-02 07:23:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix pointer-to-paramref syntax in docs

Browse Source 
The documentation for GLib and Gio contains a number of documentation
comment blocks where a parameter reference (e.g. `@err`) is also
discussed in its dereferenced pointer form, which is generally
annotated as `*@err`. This inevitably confuses the MarkDown parser,
which sees the `*` as the beginning of an italicized text span.

To avoid this, replace all `*@foo` with <code>`*foo`</code>, which
loses the `@`-sigil linking it to the `@foo` parameter, but formats
correctly in the rendered documentation. (`@foo` is automatically
formatted like <code>`foo`</code>, so the resulting appearance in
the docs is as intended.)
This commit is contained in:
FeRD (Frank Dana)
2024-12-15 18:51:26 -05:00
parent ce991fc930
commit 9f016e5de4
5 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
gio/gdbuserror.c
View File

@@ -597,7 +597,7 @@ g_dbus_error_new_for_dbus_error (const gchar *dbus_error_name,
* @format: (nullable): printf()-style format to prepend to @dbus_error_message or %NULL.
* @...: Arguments for @format.
*
* Does nothing if @error is %NULL. Otherwise sets *@error to
* Does nothing if @error is %NULL. Otherwise sets `*error` to
* a new #GError created with g_dbus_error_new_for_dbus_error()
* with @dbus_error_message prepend with @format (unless %NULL).
*

6
gio/gsocketaddressenumerator.c
View File

@@ -81,13 +81,13 @@ g_socket_address_enumerator_class_init (GSocketAddressEnumeratorClass *enumerato
* If @enumerator is expected to yield addresses, but for some reason
* is unable to (eg, because of a DNS error), then the first call to
* g_socket_address_enumerator_next() will return an appropriate error
* in *@error. However, if the first call to
* in `*error`. However, if the first call to
* g_socket_address_enumerator_next() succeeds, then any further
* internal errors (other than @cancellable being triggered) will be
* ignored.
*
* Returns: (transfer full) (nullable): a #GSocketAddress (owned by the caller), or %NULL on
* error (in which case *@error will be set) or if there are no
* error (in which case `*error` will be set) or if there are no
* more addresses.
*/
GSocketAddress *
@@ -181,7 +181,7 @@ g_socket_address_enumerator_real_next_finish (GSocketAddressEnumerator *enumera
* error handling.
*
* Returns: (transfer full) (nullable): a #GSocketAddress (owned by the caller), or %NULL on
* error (in which case *@error will be set) or if there are no
* error (in which case `*error` will be set) or if there are no
* more addresses.
*/
GSocketAddress *