From b5c07063c3531473deb1e005a0407b441ca50ade Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Mon, 15 Jan 2024 14:43:53 +0000 Subject: [PATCH] docs: Use code for class names in links So that they fit with the documentation guidelines, and with the links generated by gi-docgen. --- docs/reference/glib/datalist-and-dataset.md | 2 +- docs/reference/glib/file-utils.md | 4 ++-- docs/reference/glib/spawn.md | 4 ++-- gio/gicon.c | 5 +++-- gio/gmenumodel.c | 9 ++++---- gio/gmountoperation.c | 7 +++--- gio/gpropertyaction.c | 25 +++++++++++---------- gio/gresource.c | 16 +++++++------ glib/gvariant.c | 2 +- glib/gvarianttype.c | 10 +++++---- 10 files changed, 46 insertions(+), 38 deletions(-) diff --git a/docs/reference/glib/datalist-and-dataset.md b/docs/reference/glib/datalist-and-dataset.md index 7622fb984..ccaf9dab8 100644 --- a/docs/reference/glib/datalist-and-dataset.md +++ b/docs/reference/glib/datalist-and-dataset.md @@ -14,7 +14,7 @@ The [type@GLib.Quark] methods are quicker, since the strings have to be converted to [type@GLib.Quark]s anyway. Data lists are used for associating arbitrary data with -[GObject](../gobject/class.Object.html)s, using [`g_object_set_data()`](../gobject/method.Object.set_data.html) and related +[`GObject`](../gobject/class.Object.html)s, using [`g_object_set_data()`](../gobject/method.Object.set_data.html) and related functions. The data is stored inside opaque [type@GLib.Data] elements. To create a datalist, use [func@GLib.datalist_init]. diff --git a/docs/reference/glib/file-utils.md b/docs/reference/glib/file-utils.md index f5d1730d1..685bb47f7 100644 --- a/docs/reference/glib/file-utils.md +++ b/docs/reference/glib/file-utils.md @@ -5,8 +5,8 @@ SPDX-FileCopyrightText: 2012 Dan Winship # File Utilities Do not use these APIs unless you are porting a POSIX application to Windows. -A more high-level file access API is provided as GIO — see the documentation -for [GFile](../gio/iface.File.html). +A more high-level file access API is provided as GIO; see the documentation +for [`GFile`](../gio/iface.File.html). ## POSIX File Wrappers diff --git a/docs/reference/glib/spawn.md b/docs/reference/glib/spawn.md index af13164a4..91290b49d 100644 --- a/docs/reference/glib/spawn.md +++ b/docs/reference/glib/spawn.md @@ -15,8 +15,8 @@ and asynchronous variants ([func@GLib.spawn_async], complete shell-like command line ([func@GLib.spawn_command_line_sync], [func@GLib.spawn_command_line_async]). -See [GSubprocess](../gio/class.Subprocess.html) in GIO for a higher-level API that provides -stream interfaces for communication with child processes. +See [`GSubprocess`](../gio/class.Subprocess.html) in GIO for a higher-level API +that provides stream interfaces for communication with child processes. An example of using [func@GLib.spawn_async_with_pipes]: ```c diff --git a/gio/gicon.c b/gio/gicon.c index c98355504..cf8f12d61 100644 --- a/gio/gicon.c +++ b/gio/gicon.c @@ -63,8 +63,9 @@ * be prepared to handle at least the three following cases: * [iface@Gio.LoadableIcon], [class@Gio.ThemedIcon] and [class@Gio.EmblemedIcon]. * It may also make sense to have fast-paths for other cases (like handling - * [GdkPixbuf](https://docs.gtk.org/gdk-pixbuf/class.Pixbuf.html) directly, for example) but all compliant `GIcon` - * implementations outside of GIO must implement [iface@Gio.LoadableIcon]. + * [`GdkPixbuf`](https://docs.gtk.org/gdk-pixbuf/class.Pixbuf.html) directly, + * for example) but all compliant `GIcon` implementations outside of GIO must + * implement [iface@Gio.LoadableIcon]. * * If your application or library provides one or more `GIcon` * implementations you need to ensure that your new implementation also diff --git a/gio/gmenumodel.c b/gio/gmenumodel.c index d1b050c47..77c4dadca 100644 --- a/gio/gmenumodel.c +++ b/gio/gmenumodel.c @@ -103,10 +103,11 @@ * identifies an action in an action group. Which action group(s) provide * actions depends on the context in which the menu model is used. * E.g. when the model is exported as the application menu of a - * [GtkApplication](https://docs.gtk.org/gtk4/class.Application.html), actions can be application-wide or window-specific - * (and thus come from two different action groups). By convention, the - * application-wide actions have names that start with `app.`, while the - * names of window-specific actions start with `win.`. + * [`GtkApplication`](https://docs.gtk.org/gtk4/class.Application.html), + * actions can be application-wide or window-specific (and thus come from + * two different action groups). By convention, the application-wide actions + * have names that start with `app.`, while the names of window-specific + * actions start with `win.`. * * While a wide variety of stateful actions is possible, the following * is the minimum that is expected to be supported by all users of exported diff --git a/gio/gmountoperation.c b/gio/gmountoperation.c index 0dff498a5..1fd84af6d 100644 --- a/gio/gmountoperation.c +++ b/gio/gmountoperation.c @@ -45,9 +45,10 @@ * * Users should instantiate a subclass of this that implements all the * various callbacks to show the required dialogs, such as - * [GtkMountOperation](https://docs.gtk.org/gtk4/class.MountOperation.html). If no user interaction is desired (for example - * when automounting filesystems at login time), usually `NULL` can be - * passed, see each method taking a `GMountOperation` for details. + * [`GtkMountOperation`](https://docs.gtk.org/gtk4/class.MountOperation.html). + * If no user interaction is desired (for example when automounting + * filesystems at login time), usually `NULL` can be passed, see each method + * taking a `GMountOperation` for details. * * Throughout the API, the term ‘TCRYPT’ is used to mean ‘compatible with TrueCrypt and VeraCrypt’. * [TrueCrypt](https://en.wikipedia.org/wiki/TrueCrypt) is a discontinued system for diff --git a/gio/gpropertyaction.c b/gio/gpropertyaction.c index 320a5bc01..6b671f54b 100644 --- a/gio/gpropertyaction.c +++ b/gio/gpropertyaction.c @@ -65,22 +65,23 @@ * in sync with the property value — its state is the property value. * * For example, it might be useful to create a [iface@Gio.Action] corresponding - * to the `visible-child-name` property of a [GtkStack](https://docs.gtk.org/gtk4/class.Stack.html) so that the - * current page can be switched from a menu. The active radio indication in the - * menu is then directly determined from the active page of the - * `GtkStack`. + * to the `visible-child-name` property of a [`GtkStack`](https://docs.gtk.org/gtk4/class.Stack.html) + * so that the current page can be switched from a menu. The active radio + * indication in the menu is then directly determined from the active page of + * the `GtkStack`. * * An anti-example would be binding the `active-id` property on a - * [GtkComboBox](https://docs.gtk.org/gtk4/class.ComboBox.html). This is because the state of the combo box itself is - * probably uninteresting and is actually being used to control - * something else. + * [`GtkComboBox`](https://docs.gtk.org/gtk4/class.ComboBox.html). This is + * because the state of the combo box itself is probably uninteresting and is + * actually being used to control something else. * * Another anti-example would be to bind to the `visible-child-name` - * property of a [GtkStack](https://docs.gtk.org/gtk4/class.Stack.html) if this value is actually stored in - * [class@Gio.Settings]. In that case, the real source of the value is - * [class@Gio.Settings]. If you want a [iface@Gio.Action] to control a setting - * stored in [class@Gio.Settings], see [method@Gio.Settings.create_action] - * instead, and possibly combine its use with [method@Gio.Settings.bind]. + * property of a [`GtkStack`](https://docs.gtk.org/gtk4/class.Stack.html) if + * this value is actually stored in [class@Gio.Settings]. In that case, the + * real source of the value is* [class@Gio.Settings]. If you want + * a [iface@Gio.Action] to control a setting stored in [class@Gio.Settings], + * see [method@Gio.Settings.create_action] instead, and possibly combine its + * use with [method@Gio.Settings.bind]. * * Since: 2.38 **/ diff --git a/gio/gresource.c b/gio/gresource.c index d75da7162..8ce00d49d 100644 --- a/gio/gresource.c +++ b/gio/gresource.c @@ -52,9 +52,10 @@ G_DEFINE_BOXED_TYPE (GResource, g_resource, g_resource_ref, g_resource_unref) * * Applications and libraries often contain binary or textual data that is * really part of the application, rather than user data. For instance - * [GtkBuilder](https://docs.gtk.org/gtk4/class.Builder.html) `.ui` files, splashscreen images, [class@Gio.Menu] markup - * XML, CSS files, icons, etc. These are often shipped as files in - * `$datadir/appname`, or manually included as literal strings in the code. + * [`GtkBuilder`](https://docs.gtk.org/gtk4/class.Builder.html) `.ui` files, + * splashscreen images, [class@Gio.Menu] markup XML, CSS files, icons, etc. + * These are often shipped as files in `$datadir/appname`, or manually + * included as literal strings in the code. * * The `GResource` API and the * [`glib-compile-resources`](glib-compile-resources.html) program provide a @@ -82,7 +83,7 @@ G_DEFINE_BOXED_TYPE (GResource, g_resource, g_resource_ref, g_resource_unref) * the preprocessing step is skipped. * * - `to-pixdata` (deprecated since gdk-pixbuf 2.32) which will use the - * `gdk-pixbuf-pixdata` command to convert images to the [GdkPixdata](https://docs.gtk.org/gdk-pixbuf/class.Pixdata.html) + * `gdk-pixbuf-pixdata` command to convert images to the [`GdkPixdata`](https://docs.gtk.org/gdk-pixbuf/class.Pixdata.html) * format, which allows you to create pixbufs directly using the data inside * the resource file, rather than an (uncompressed) copy of it. For this, the * `gdk-pixbuf-pixdata` program must be in the `PATH`, or the @@ -155,9 +156,10 @@ G_DEFINE_BOXED_TYPE (GResource, g_resource, g_resource_ref, g_resource_unref) * also use URIs like `resource:///org/gtk/Example/data/splashscreen.png` with * [iface@Gio.File] to access the resource data. * - * Some higher-level APIs, such as [GtkApplication](https://docs.gtk.org/gtk4/class.Application.html), will automatically - * load resources from certain well-known paths in the resource namespace as a - * convenience. See the documentation for those APIs for details. + * Some higher-level APIs, such as [`GtkApplication`](https://docs.gtk.org/gtk4/class.Application.html), + * will automatically load resources from certain well-known paths in the + * resource namespace as a convenience. See the documentation for those APIs + * for details. * * There are two forms of the generated source, the default version uses the * compiler support for constructor and destructor functions (where available) diff --git a/glib/gvariant.c b/glib/gvariant.c index 69305ca9d..651771bad 100644 --- a/glib/gvariant.c +++ b/glib/gvariant.c @@ -48,7 +48,7 @@ * * `GVariant` is useful whenever data needs to be serialized, for example when * sending method parameters in D-Bus, or when saving settings using - * [GSettings](../gio/class.Settings.html). + * [`GSettings`](../gio/class.Settings.html). * * When creating a new `GVariant`, you pass the data you want to store in it * along with a string representing the type of data you wish to pass to it. diff --git a/glib/gvarianttype.c b/glib/gvarianttype.c index c28de6823..370aee176 100644 --- a/glib/gvarianttype.c +++ b/glib/gvarianttype.c @@ -88,9 +88,10 @@ * This is similar to how instances of abstract classes may not * directly exist in other type systems, but instances of their * non-abstract subtypes may. For example, in GTK, no object that has - * the type of [GtkWidget](https://docs.gtk.org/gtk4/class.Widget.html) can exist (since `GtkWidget` is an - * abstract class), but a [GtkWindow](https://docs.gtk.org/gtk4/class.Window.html) can certainly be instantiated, and - * you would say that a `GtkWidget` is a `GtkWidget` (since `GtkWidget` is a subclass of `GtkWidget`). + * the type of [`GtkWidget`](https://docs.gtk.org/gtk4/class.Widget.html) can + * exist (since `GtkWidget` is an abstract class), but a [`GtkWindow`](https://docs.gtk.org/gtk4/class.Window.html) + * can certainly be instantiated, and you would say that a `GtkWidget` is a + * `GtkWidget` (since `GtkWidget` is a subclass of `GtkWidget`). * * Two types may not be compared by value; use [method@GLib.VariantType.equal] * or [method@GLib.VariantType.is_subtype_of] May be copied using @@ -118,7 +119,8 @@ * `a(aa(ui)(qna{ya(yd)}))`. In order to not hit memory limits, * [type@GLib.Variant] imposes a limit on recursion depth of 65 nested * containers. This is the limit in the D-Bus specification (64) plus one to - * allow a [GDBusMessage](../gio/class.DBusMessage.html) to be nested in a top-level tuple. + * allow a [`GDBusMessage`](../gio/class.DBusMessage.html) to be nested in + * a top-level tuple. * * The meaning of each of the characters is as follows: *