gio: Fix invalid doc links

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
This commit is contained in:
Philip Withnall
2023-10-23 11:17:24 +01:00
parent 016aacbda8
commit 635100b1f5
19 changed files with 63 additions and 62 deletions

View File

@@ -48,7 +48,7 @@ G_DEFINE_INTERFACE (GAction, g_action, G_TYPE_OBJECT)
*
* `GAction` is merely the interface to the concept of an action, as
* described above. Various implementations of actions exist, including
* [struct@Gio.SimpleAction].
* [class@Gio.SimpleAction].
*
* In all cases, the implementing class is responsible for storing the
* name of the action, the parameter type, the enabled state, the optional
@@ -58,7 +58,7 @@ G_DEFINE_INTERFACE (GAction, g_action, G_TYPE_OBJECT)
* for type safety and for the state being enabled.
*
* Probably the only useful thing to do with a `GAction` is to put it
* inside of a [struct@Gio.SimpleActionGroup].
* inside of a [class@Gio.SimpleActionGroup].
**/
/**

View File

@@ -30,9 +30,9 @@
*
* `GActionMap` is an interface for action containers.
*
* The `GActionMap` interface is implemented by [struct@Gio.ActionGroup]
* The `GActionMap` interface is implemented by [iface@Gio.ActionGroup]
* implementations that operate by containing a number of named
* [struct@Gio.Action] instances, such as [struct@Gio.SimpleActionGroup].
* [iface@Gio.Action] instances, such as [class@Gio.SimpleActionGroup].
*
* One useful application of this interface is to map the
* names of actions from various action groups to unique,

View File

@@ -67,10 +67,10 @@
* passed unmodified to the application.
*
* Specifically for GVfs 2.26 and later, the POSIX URI will be mapped
* back to the GIO URI in the [struct@Gio.File] constructors (since GVfs
* back to the GIO URI in the [iface@Gio.File] constructors (since GVfs
* implements the GVfs extension point). As such, if the application
* needs to examine the URI, it needs to use [method@Gio.File.get_uri]
* or similar on [struct@Gio.File]. In other words, an application cannot
* or similar on [iface@Gio.File]. In other words, an application cannot
* assume that the URI passed to e.g. [func@Gio.File.new_for_commandline_arg]
* is equal to the result of [method@Gio.File.get_uri]. The following snippet
* illustrates this:
@@ -1661,24 +1661,24 @@ g_app_launch_context_launch_failed (GAppLaunchContext *context,
* info database for changes (newly installed or removed applications).
*
* Call [func@Gio.AppInfoMonitor.get] to get a `GAppInfoMonitor` and connect
* to the [signal@Gio.AppInfoMonitor.changed] signal. The signal will be emitted once when
* to the [signal@Gio.AppInfoMonitor::changed] signal. The signal will be emitted once when
* the app info database changes, and will not be emitted again until after the
* next call to [func@Gio.AppInfo.get_all] or another `g_app_info_*()` function.
* This is because monitoring the app info database for changes is expensive.
*
* The following functions will re-arm the [signal@Gio.AppInfoMonitor.changed]
* The following functions will re-arm the [signal@Gio.AppInfoMonitor::changed]
* signal so it can be emitted again:
*
* - [method@Gio.AppInfo.get_all]
* - [method@Gio.AppInfo.get_all_for_type]
* - [method@Gio.AppInfo.get_default_for_type]
* - [method@Gio.AppInfo.get_fallback_for_type]
* - [method@Gio.AppInfo.get_recommended_for_type]
* - [method@Gio.DesktopAppInfo.get_implementations]
* - [method@Gio.DesktopAppInfo.new]
* - [method@Gio.DesktopAppInfo.new_from_filename]
* - [method@Gio.DesktopAppInfo.new_from_keyfile]
* - [method@Gio.DesktopAppInfo.search]
* - [func@Gio.AppInfo.get_all]
* - [func@Gio.AppInfo.get_all_for_type]
* - [func@Gio.AppInfo.get_default_for_type]
* - [func@Gio.AppInfo.get_fallback_for_type]
* - [func@Gio.AppInfo.get_recommended_for_type]
* - [func@Gio.DesktopAppInfo.get_implementations]
* - [ctor@Gio.DesktopAppInfo.new]
* - [ctor@Gio.DesktopAppInfo.new_from_filename]
* - [ctor@Gio.DesktopAppInfo.new_from_keyfile]
* - [func@Gio.DesktopAppInfo.search]
*
* In the usual case, applications should try to make note of the change
* (doing things like invalidating caches) but not act on it. In

View File

@@ -106,17 +106,17 @@
* any object paths that you wish to register are registered before #GApplication
* attempts to acquire the bus name of your application (which happens in
* [method@Gio.Application.register]). Unfortunately, this means that you cannot
* use [method@Gio.Application.is_remote] to decide if you want to register
* use [property@Gio.Application:is-remote] to decide if you want to register
* object paths.
*
* `GApplication` also implements the [struct@Gio.ActionGroup] and [struct@Gio.ActionMap]
* `GApplication` also implements the [iface@Gio.ActionGroup] and [iface@Gio.ActionMap]
* interfaces and lets you easily export actions by adding them with
* [method@Gio.ActionMap.add_action]. When invoking an action by calling
* [method@Gio.ActionGroup.activate_action] on the application, it is always
* invoked in the primary instance. The actions are also exported on
* the session bus, and GIO provides the [struct@Gio.DBusActionGroup] wrapper to
* conveniently access them remotely. GIO provides a [struct@Gio.DBusMenuModel] wrapper
* for remote access to exported [struct@Gio.MenuModel]s.
* the session bus, and GIO provides the [class@Gio.DBusActionGroup] wrapper to
* conveniently access them remotely. GIO provides a [class@Gio.DBusMenuModel] wrapper
* for remote access to exported [class@Gio.MenuModel]s.
*
* Note: Due to the fact that actions are exported on the session bus,
* using `maybe` parameters is not supported, since D-Bus does not support
@@ -132,7 +132,7 @@
*
* - via activating an action
*
* The [signal@Gio.Application.startup] signal lets you handle the application
* The [signal@Gio.Application::startup] signal lets you handle the application
* initialization for all of these in a single place.
*
* Regardless of which of these entry points is used to start the
@@ -142,7 +142,7 @@
* data, override the [vfunc@Gio.Application.before_emit] or
* [vfunc@Gio.Application.after_emit] virtual functions
* in your `GApplication` subclass. When dealing with
* [struct@Gio.ApplicationCommandLine] objects, the platform data is
* [class@Gio.ApplicationCommandLine] objects, the platform data is
* directly available via [method@Gio.ApplicationCommandLine.get_cwd],
* [method@Gio.ApplicationCommandLine.get_environ] and
* [method@Gio.ApplicationCommandLine.get_platform_data].
@@ -158,7 +158,7 @@
* `GtkApplication` adds startup notification data in this way.
*
* To parse commandline arguments you may handle the
* [signal@Gio.Application.command-line] signal or override the
* [signal@Gio.Application::command-line] signal or override the
* [vfunc@Gio.Application.local_command_line] virtual funcion, to parse them in
* either the primary instance or the local instance, respectively.
*

View File

@@ -45,8 +45,8 @@
* `GApplicationCommandLine` represents a command-line invocation of
* an application.
*
* It is created by [struct@Gio.Application] and emitted
* in the [signal@Gio.Application.command-line] signal and virtual function.
* It is created by [class@Gio.Application] and emitted
* in the [signal@Gio.Application::command-line] signal and virtual function.
*
* The class contains the list of arguments that the program was invoked
* with. It is also possible to query if the commandline invocation was
@@ -67,7 +67,7 @@
* dropped).
*
* The main use for `GApplicationCommandLine` (and the
* [signal@Gio.Application.command-line] signal) is 'Emacs server' like use cases:
* [signal@Gio.Application::command-line] signal) is 'Emacs server' like use cases:
* You can set the `EDITOR` environment variable to have e.g. git use
* your favourite editor to edit commit messages, and if you already
* have an instance of the editor running, the editing will happen
@@ -76,7 +76,7 @@
* does not return until the editing is done.
*
* Normally, the commandline is completely handled in the
* [signal@Gio.Application.command-line handler]. The launching instance exits
* [signal@Gio.Application::command-line] handler. The launching instance exits
* once the signal handler in the primary instance has returned, and
* the return value of the signal handler becomes the exit status
* of the launching instance.
@@ -161,7 +161,7 @@
*
* In this example of split commandline handling, options that start
* with `--local-` are handled locally, all other options are passed
* to the [signal@Gio.Application.command-line] handler which runs in the primary
* to the [signal@Gio.Application::command-line] handler which runs in the primary
* instance.
*
* The complete example can be found here:
@@ -202,7 +202,7 @@
* ```
*
* In this example the commandline is not completely handled before
* the [signal@Gio.Application.command-line] handler returns. Instead, we keep
* the [signal@Gio.Application::command-line] handler returns. Instead, we keep
* a reference to the `GApplicationCommandLine` object and handle it
* later (in this example, in an idle). Note that it is necessary to
* hold the application until you are done with the commandline.

View File

@@ -33,7 +33,7 @@
*
* `GAsyncInitable` is an interface for asynchronously initializable objects.
*
* This is the asynchronous version of [struct@Gio.Initable]; it behaves the same
* This is the asynchronous version of [iface@Gio.Initable]; it behaves the same
* in all ways except that initialization is asynchronous. For more details
* see the descriptions on `GInitable`.
*
@@ -41,9 +41,9 @@
*
* Users of objects implementing this are not intended to use the interface
* method directly; instead it will be used automatically in various ways.
* For C applications you generally just call [func@Gio.AsyncInitiable.new_async]
* For C applications you generally just call [func@Gio.AsyncInitable.new_async]
* directly, or indirectly via a foo_thing_new_async() wrapper. This will call
* [func@Gio.AsyncInitable.init_async] under the covers, calling back with `NULL`
* [method@Gio.AsyncInitable.init_async] under the covers, calling back with `NULL`
* and a set `GError` on failure.
*
* A typical implementation might look something like this:

View File

@@ -48,7 +48,7 @@
*
* The `_finish()` function for an operation takes the generic result
* (of type `GAsyncResult`) and returns the specific result that the
* operation in question yields (e.g. a [struct@Gio.FileEnumerator] for a
* operation in question yields (e.g. a [class@Gio.FileEnumerator] for a
* "enumerate children" operation). If the result or error status of the
* operation is not needed, there is no need to call the `_finish()`
* function; GIO will take care of cleaning up the result and error

View File

@@ -41,8 +41,8 @@
*
* By default, `GBufferedInputStream`'s buffer size is set at 4 kilobytes.
*
* To create a buffered input stream, use [func@Gio.BufferedInputStream.new],
* or [func@Gio.BufferedInputStream.new_sized] to specify the buffer's size at
* To create a buffered input stream, use [ctor@Gio.BufferedInputStream.new],
* or [ctor@Gio.BufferedInputStream.new_sized] to specify the buffer's size at
* construction.
*
* To get the size of a buffer within a buffered input stream, use

View File

@@ -32,13 +32,13 @@
/**
* GBufferedOutputStream:
*
* Buffered output stream implements [struct@Gio.FilterOutputStream] and provides
* Buffered output stream implements [class@Gio.FilterOutputStream] and provides
* for buffered writes.
*
* By default, `GBufferedOutputStream`'s buffer size is set at 4 kilobytes.
*
* To create a buffered output stream, use [func@Gio.BufferedOutputStream.new],
* or [func@Gio.BufferedOutputStream.new_sized] to specify the buffer's size
* To create a buffered output stream, use [ctor@Gio.BufferedOutputStream.new],
* or [ctor@Gio.BufferedOutputStream.new_sized] to specify the buffer's size
* at construction.
*
* To get the size of a buffer within a buffered input stream, use

View File

@@ -42,7 +42,7 @@ enum {
* GCharsetConverter:
*
* `GCharsetConverter` is an implementation of [iface@Gio.Converter] based on
* [class@GLib.IConv].
* [struct@GLib.IConv].
*/
static void g_charset_converter_iface_init (GConverterIface *iface);

View File

@@ -35,7 +35,7 @@
/**
* GConverterInputStream:
*
* Converter input stream implements [iface@Gio.InputStream] and allows
* Converter input stream implements [class@Gio.InputStream] and allows
* conversion of data of various types during reading.
*
* As of GLib 2.34, `GConverterInputStream` implements

View File

@@ -35,7 +35,7 @@
/**
* GConverterOutputStream:
*
* Converter output stream implements [iface@Gio.OutputStream] and allows
* Converter output stream implements [class@Gio.OutputStream] and allows
* conversion of data of various types during reading.
*
* As of GLib 2.34, `GConverterOutputStream` implements

View File

@@ -48,7 +48,7 @@
* peer of a communication endpoint - see e.g. [method@Gio.Socket.get_credentials].
*
* Some operating systems supports securely sending and receiving
* credentials over a Unix Domain Socket, see [struct@Gio.UnixCredentialsMessage],
* credentials over a Unix Domain Socket, see [class@Gio.UnixCredentialsMessage],
* [method@Gio.UnixConnection.send_credentials] and
* [method@Gio.UnixConnection.receive_credentials] for details.
*

View File

@@ -39,10 +39,10 @@
* A `GDatagramBased` is a networking interface for representing datagram-based
* communications. It is a more or less direct mapping of the core parts of the
* BSD socket API in a portable GObject interface. It is implemented by
* [struct@Gio.Socket], which wraps the UNIX socket API on UNIX and winsock2 on Windows.
* [class@Gio.Socket], which wraps the UNIX socket API on UNIX and winsock2 on Windows.
*
* `GDatagramBased` is entirely platform independent, and is intended to be used
* alongside higher-level networking APIs such as [struct@Gio.IOStream].
* alongside higher-level networking APIs such as [class@Gio.IOStream].
*
* It uses vectored scatter/gather I/O by default, allowing for many messages
* to be sent or received in a single call. Where possible, implementations of

View File

@@ -35,7 +35,7 @@
/**
* GDataInputStream:
*
* Data input stream implements [iface@Gio.InputStream] and includes functions
* Data input stream implements [class@Gio.InputStream] and includes functions
* for reading structured data directly from a binary input stream.
*/

View File

@@ -32,7 +32,7 @@
/**
* GDataOutputStream:
*
* Data output stream implements [iface@Gio.OutputStream] and includes functions
* Data output stream implements [class@Gio.OutputStream] and includes functions
* for writing data directly to an output stream.
*/

View File

@@ -35,7 +35,7 @@
* interface.
*
* `GDBusActionGroup` can be used as a proxy for an action group
* that is exported over D-Bus with [func@Gio.DBusConnection.export_action_group].
* that is exported over D-Bus with [method@Gio.DBusConnection.export_action_group].
*/
struct _GDBusActionGroup

View File

@@ -138,32 +138,33 @@
*
* It is a low-level API that offers a lot of flexibility. For instance,
* it lets you establish a connection over any transport that can by represented
* as a [struct@Gio.IOStream].
* as a [class@Gio.IOStream].
*
* This class is rarely used directly in D-Bus clients. If you are writing
* a D-Bus client, it is often easier to use the [func@g_bus_own_name],
* [func@g_bus_watch_name] or [ctor@Gio.DBusProxy.new_for_bus] APIs.
* a D-Bus client, it is often easier to use the [func@Gio.bus_own_name],
* [func@Gio.bus_watch_name] or [func@Gio.DBusProxy.new_for_bus] APIs.
*
* As an exception to the usual GLib rule that a particular object must not
* be used by two threads at the same time, `GDBusConnection`s methods may be
* called from any thread. This is so that `g_bus_get()` and `g_bus_get_sync()`
* can safely return the same `GDBusConnection` when called from any thread.
* called from any thread. This is so that [func@Gio.bus_get] and
* [func@Gio.bus_get_sync] can safely return the same `GDBusConnection` when
* called from any thread.
*
* Most of the ways to obtain a `GDBusConnection` automatically initialize it
* (i.e. connect to D-Bus): for instance, [func@Gio.DBusConnection.new] and
* `g_bus_get()`, and the synchronous versions of those methods, give you an
* initialized connection. Language bindings for GIO should use
* [func@Gio.Initiable.new] or [func@Gio.AsyncInitable.new_async], which also
* [func@Gio.bus_get], and the synchronous versions of those methods, give you
* an initialized connection. Language bindings for GIO should use
* [func@Gio.Initable.new] or [func@Gio.AsyncInitable.new_async], which also
* initialize the connection.
*
* If you construct an uninitialized `GDBusConnection`, such as via
* `g_object_new()`, you must initialize it via [method@Gio.Initable.init] or
* [ctor@GObject.Object.new], you must initialize it via [method@Gio.Initable.init] or
* [method@Gio.AsyncInitable.init_async] before using its methods or properties.
* Calling methods or accessing properties on a `GDBusConnection` that has not
* completed initialization successfully is considered to be invalid, and leads
* to undefined behaviour. In particular, if initialization fails with a
* `GError`, the only valid thing you can do with that `GDBusConnection` is to
* free it with `g_object_unref()`.
* free it with [method@GObject.Object.unref].
*
* ## An example D-Bus server
*

View File

@@ -33,8 +33,8 @@
* Base type for D-Bus interfaces.
*
* The `GDBusInterface` type is the base type for D-Bus interfaces both
* on the service side (see [struct@Gio.DBusInterfaceSkeleton]) and client side
* (see [struct@Gio.DBusProxy]).
* on the service side (see [class@Gio.DBusInterfaceSkeleton]) and client side
* (see [class@Gio.DBusProxy]).
*
* Since: 2.30
*/