luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-01 21:33:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move the GDrive SECTION

Browse Source 
Move it to the struct docs.

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

Helps: #3037
This commit is contained in:
Philip Withnall 2023-10-23 13:40:02 +01:00
parent 508e164056
commit 396b0af3ab
1 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
gio/gdrive.c
View File

@ -31,36 +31,34 @@
/** /**
* SECTION:gdrive * GDrive:
* @short_description: Drive management
* @include: gio/gio.h
* *
* #GDrive - this represent a piece of hardware connected to the machine. * `GDrive` represents a piece of hardware connected to the machine.
* It's generally only created for removable hardware or hardware with * It’s generally only created for removable hardware or hardware with
* removable media. * removable media.
* *
* #GDrive is a container class for #GVolume objects that stem from * `GDrive` is a container class for [class@Gio.Volume] objects that stem from
* the same piece of media. As such, #GDrive abstracts a drive with * the same piece of media. As such, `GDrive` abstracts a drive with
* (or without) removable media and provides operations for querying * (or without) removable media and provides operations for querying
* whether media is available, determining whether media change is * whether media is available, determining whether media change is
* automatically detected and ejecting the media. * automatically detected and ejecting the media.
* *
* If the #GDrive reports that media isn't automatically detected, one * If the `GDrive` reports that media isn’t automatically detected, one
* can poll for media; typically one should not do this periodically * can poll for media; typically one should not do this periodically
* as a poll for media operation is potentially expensive and may * as a poll for media operation is potentially expensive and may
* spin up the drive creating noise. * spin up the drive creating noise.
* *
* #GDrive supports starting and stopping drives with authentication * `GDrive` supports starting and stopping drives with authentication
* support for the former. This can be used to support a diverse set * support for the former. This can be used to support a diverse set
* of use cases including connecting/disconnecting iSCSI devices, * of use cases including connecting/disconnecting iSCSI devices,
* powering down external disk enclosures and starting/stopping * powering down external disk enclosures and starting/stopping
* multi-disk devices such as RAID devices. Note that the actual * multi-disk devices such as RAID devices. Note that the actual
* semantics and side-effects of starting/stopping a #GDrive may vary * semantics and side-effects of starting/stopping a `GDrive` may vary
* according to implementation. To choose the correct verbs in e.g. a * according to implementation. To choose the correct verbs in e.g. a
* file manager, use g_drive_get_start_stop_type(). * file manager, use [method@Gio.Drive.get_start_stop_type].
* *
* For porting from GnomeVFS note that there is no equivalent of * For [porting from GnomeVFS](migrating-gnome-vfs.html) note that there is no
* #GDrive in that API. * equivalent of `GDrive` in that API.
**/ **/
typedef GDriveIface GDriveInterface; typedef GDriveIface GDriveInterface;