Merge branch 'altiera/docs' into 'main'

docs: Fix links to symbols outside the allowed namsepace

See merge request GNOME/glib!3809
This commit is contained in:
Emmanuele Bassi 2024-01-18 18:35:21 +00:00
commit 4ff4f073a4
15 changed files with 59 additions and 54 deletions

View File

@ -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
[class@GObject.Object]s, using [method@GObject.Object.set_data] 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].

View File

@ -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 [iface@Gio.File].
A more high-level file access API is provided as GIO; see the documentation
for [`GFile`](../gio/iface.File.html).
## POSIX File Wrappers

View File

@ -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 [class@Gio.Subprocess] 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

View File

@ -68,8 +68,8 @@ An untyped pointer, exactly equivalent to `void *`.
The standard C `void *` type should usually be preferred in
new code, but `gpointer` can be used in contexts where a type name
must be a single word, such as in the [method@GObject.Type.name] of
[const@GObject.TYPE_POINTER] or when generating a family of function names for
must be a single word, such as in the `GType` name of
`G_TYPE_POINTER` or when generating a family of function names for
multiple types using macros.
### `gconstpointer`
@ -98,8 +98,8 @@ Equivalent to the standard C `unsigned char` type.
The standard C `unsigned char` type should usually be preferred in
new code, but `guchar` can be used in contexts where a type name
must be a single word, such as in the [method@GObject.Type.name] of
[const@GObject.TYPE_UCHAR] or when generating a family of function names for
must be a single word, such as in the `GType` name of
`G_TYPE_UCHAR` or when generating a family of function names for
multiple types using macros.
## Naturally Sized Integers
@ -135,8 +135,8 @@ or equivalently `0` to `G_MAXUINT`.
The standard C `unsigned int` type should usually be preferred in
new code, but `guint` can be used in contexts where a type name
must be a single word, such as in the [method@GObject.Type.name] of
[const@GObject.TYPE_UINT] or when generating a family of function names for
must be a single word, such as in the `GType` name of
`G_TYPE_UINT` or when generating a family of function names for
multiple types using macros.
`G_MAXUINT`
@ -216,8 +216,8 @@ Values of this type can range from `0` to `G_MAXULONG`.
The standard C `unsigned long` type should usually be preferred in
new code, but `gulong` can be used in contexts where a type name
must be a single word, such as in the [method@GObject.Type.name] of
[const@GObject.TYPE_ULONG] or when generating a family of function names for
must be a single word, such as in the `GType` name of
`G_TYPE_ULONG` or when generating a family of function names for
multiple types using macros.
`G_MAXULONG`

View File

@ -55,7 +55,7 @@
* commandline to this process).
*
* The `GApplicationCommandLine` object can provide the @argc and @argv
* parameters for use with the [struct@Glib.OptionContext] command-line parsing API,
* parameters for use with the [struct@GLib.OptionContext] command-line parsing API,
* with the [method@Gio.ApplicationCommandLine.get_arguments] function. See
* [gapplication-example-cmdline3.c][gapplication-example-cmdline3]
* for an example.

View File

@ -62,7 +62,7 @@
* `G_IO_ERROR_TIMED_OUT` if no progress was made. To know when a call would
* successfully run you can call [method@Gio.DatagramBased.condition_check] or
* [method@Gio.DatagramBased.condition_wait]. You can also use
* [method@Gio.DatagramBased.create_source] and attach it to a [struct@Glib.MainContext]
* [method@Gio.DatagramBased.create_source] and attach it to a [struct@GLib.MainContext]
* to get callbacks when I/O is possible.
*
* When running a non-blocking operation applications should always be able to

View File

@ -42,8 +42,8 @@
* stream to jump to arbitrary positions in the file, provided the
* filesystem of the file allows it. To find the position of a file
* input stream, use [method@Gio.Seekable.tell]. To find out if a file input
* stream supports seeking, use [iface@Gio.Seekable.can_seek].
* To position a file input stream, use [iface@Gio.Seekable.seek].
* stream supports seeking, use [vfunc@Gio.Seekable.can_seek].
* To position a file input stream, use [vfunc@Gio.Seekable.seek].
**/
static void g_file_input_stream_seekable_iface_init (GSeekableIface *iface);

View File

@ -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
* [class@GdkPixbuf.Pixbuf] 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

View File

@ -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
* [class@Gtk.Application], 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

View File

@ -45,9 +45,10 @@
*
* Users should instantiate a subclass of this that implements all the
* various callbacks to show the required dialogs, such as
* [class@Gtk.MountOperation]. 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

View File

@ -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 [class@Gtk.Stack] 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
* [class@Gtk.Stack].
* 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
* [class@Gtk.ComboBox]. This is because the state of the combobox 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 [class@Gtk.Stack] 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
**/

View File

@ -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
* [class@Gtk.Builder] `.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 [class@Gdk.Pixdata]
* `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 [class@Gtk.Application], 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)

View File

@ -32,8 +32,6 @@
* A `GSimpleAction` is the obvious simple implementation of the
* [iface@Gio.Action] interface. This is the easiest way to create an action for
* purposes of adding it to a [class@Gio.SimpleActionGroup].
*
* See also [class@Gtk.Action].
*/
struct _GSimpleAction

View File

@ -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
* [class@Gio.Settings].
* [`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.
@ -93,7 +93,7 @@
* `GVariant` instances can be sent over D-Bus. See [type@GLib.VariantType] for
* exceptions. (However, `GVariant`s serialization format is not the same
* as the serialization format of a D-Bus message body: use
* [class@Gio.DBusMessage], in the GIO library, for those.)
* [GDBusMessage](../gio/class.DBusMessage.html), in the GIO library, for those.)
*
* For space-efficiency, the `GVariant` serialization format does not
* automatically include the variants length, type or endianness,

View File

@ -88,10 +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 [class@Gtk.Widget] can exist (since [class@Gtk.Widget] is an
* abstract class), but a [class@Gtk.Window] can certainly be instantiated, and
* you would say that the [class@Gtk.Window] is a [class@Gtk.Widget] (since
* [class@Gtk.Window] is a subclass of [class@Gtk.Widget]).
* 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
@ -119,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 [class@Gio.DBusMessage] 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:
*