docs: Clarify distinction between GDrive, GVolume and GMount

Provide examples of what they all represent, and expand on the
descriptions of them in a few places.

Move references to their equivalents from `GnomeVFS` to lower down in
the documentation, since `GnomeVFS` has been deprecated for many years
now, and is unlikely to be pertinent to most readers.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
This commit is contained in:
Philip Withnall
2024-08-15 11:32:37 +01:00
parent 02ffe6a779
commit b4332b0056
4 changed files with 20 additions and 10 deletions

View File

@@ -39,14 +39,15 @@
/**
* GMount:
*
* The `GMount` interface represents user-visible mounts. Note, when
* [porting from GnomeVFS](migrating-gnome-vfs.html), `GMount` is the moral
* equivalent of `GnomeVFSVolume`.
* The `GMount` interface represents a user-visible mount, such as a mounted
* file system.
*
* `GMount` is a mounted filesystem that you can access. Mounted is in
* quotes because its not the same as a UNIX mount, it might be a GVFS
* mount, but you can still access the files on it if you use GIO. Might or
* might not be related to a volume object.
* mount, but you can still access the files on it if you use GIO.
*
* A `GMount` might be associated with a [iface@Gio.Volume] (such as a USB flash
* drive) which hosts it.
*
* Unmounting a `GMount` instance is an asynchronous operation. For
* more information about asynchronous operations, see [iface@Gio.AsyncResult]
@@ -60,6 +61,9 @@
* operation was completed successfully. If an `error` is present when
* [method@Gio.Mount.unmount_with_operation_finish] is called, then it will be
* filled with any error information.
*
* Note, when [porting from GnomeVFS](migrating-gnome-vfs.html), `GMount` is the
* moral equivalent of `GnomeVFSVolume`.
**/
typedef GMountIface GMountInterface;