luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-12 23:46:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix and update GI annotations for 'Volumes and Drives'

Browse Source 
Volumes and Drives GIO category contains: GVolumeMonitor, GVolume,
GMount, GDrive, Unix Mounts.
This commit is contained in:
Pavel Holejsovsky 2011-01-07 14:52:29 +01:00
parent f85909fb65
commit f6b52322a2
4 changed files with 55 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
gio/gdrive.c
View File

@ -331,8 +331,8 @@ g_drive_can_poll_for_media (GDrive *drive)
* g_drive_eject: * g_drive_eject:
* @drive: a #GDrive. * @drive: a #GDrive.
* @flags: flags affecting the unmount if required for eject * @flags: flags affecting the unmount if required for eject
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback, or %NULL. * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
* @user_data: user data to pass to @callback * @user_data: user data to pass to @callback
* *
* Asynchronously ejects a drive. * Asynchronously ejects a drive.
@ -407,9 +407,10 @@ g_drive_eject_finish (GDrive *drive,
* g_drive_eject_with_operation: * g_drive_eject_with_operation:
* @drive: a #GDrive. * @drive: a #GDrive.
* @flags: flags affecting the unmount if required for eject * @flags: flags affecting the unmount if required for eject
* @mount_operation: a #GMountOperation or %NULL to avoid user interaction. * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid
* @cancellable: optional #GCancellable object, %NULL to ignore. * user interaction.
* @callback: a #GAsyncReadyCallback, or %NULL. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
* @user_data: user data passed to @callback. * @user_data: user data passed to @callback.
* *
* Ejects a drive. This is an asynchronous operation, and is * Ejects a drive. This is an asynchronous operation, and is
@ -491,8 +492,8 @@ g_drive_eject_with_operation_finish (GDrive *drive,
/** /**
* g_drive_poll_for_media: * g_drive_poll_for_media:
* @drive: a #GDrive. * @drive: a #GDrive.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback, or %NULL. * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
* @user_data: user data to pass to @callback * @user_data: user data to pass to @callback
* *
* Asynchronously polls @drive to see if media has been inserted or removed. * Asynchronously polls @drive to see if media has been inserted or removed.
@ -594,8 +595,9 @@ g_drive_get_identifier (GDrive *drive,
* Use g_drive_get_identifer() to obtain the identifiers * Use g_drive_get_identifer() to obtain the identifiers
* themselves. * themselves.
* *
* Returns: (transfer full): a %NULL-terminated array of strings containing * Returns: (transfer full) (array zero-terminated=1): a %NULL-terminated
* kinds of identifiers. Use g_strfreev() to free. * array of strings containing kinds of identifiers. Use g_strfreev()
* to free.
*/ */
char ** char **
g_drive_enumerate_identifiers (GDrive *drive) g_drive_enumerate_identifiers (GDrive *drive)
@ -691,9 +693,10 @@ g_drive_can_start_degraded (GDrive *drive)
* g_drive_start: * g_drive_start:
* @drive: a #GDrive. * @drive: a #GDrive.
* @flags: flags affecting the start operation. * @flags: flags affecting the start operation.
* @mount_operation: a #GMountOperation or %NULL to avoid user interaction. * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid
* @cancellable: optional #GCancellable object, %NULL to ignore. * user interaction.
* @callback: a #GAsyncReadyCallback, or %NULL. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
* @user_data: user data to pass to @callback * @user_data: user data to pass to @callback
* *
* Asynchronously starts a drive. * Asynchronously starts a drive.
@ -793,9 +796,10 @@ g_drive_can_stop (GDrive *drive)
* g_drive_stop: * g_drive_stop:
* @drive: a #GDrive. * @drive: a #GDrive.
* @flags: flags affecting the unmount if required for stopping. * @flags: flags affecting the unmount if required for stopping.
* @mount_operation: a #GMountOperation or %NULL to avoid user interaction. * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid
* @cancellable: optional #GCancellable object, %NULL to ignore. * user interaction.
* @callback: a #GAsyncReadyCallback, or %NULL. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
* @user_data: user data to pass to @callback * @user_data: user data to pass to @callback
* *
* Asynchronously stops a drive. * Asynchronously stops a drive.

33
gio/gmount.c
View File

@ -329,8 +329,8 @@ g_mount_can_eject (GMount *mount)
* g_mount_unmount: * g_mount_unmount:
* @mount: a #GMount. * @mount: a #GMount.
* @flags: flags affecting the operation * @flags: flags affecting the operation
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback, or %NULL. * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
* @user_data: user data passed to @callback. * @user_data: user data passed to @callback.
* *
* Unmounts a mount. This is an asynchronous operation, and is * Unmounts a mount. This is an asynchronous operation, and is
@ -408,8 +408,8 @@ g_mount_unmount_finish (GMount *mount,
* g_mount_eject: * g_mount_eject:
* @mount: a #GMount. * @mount: a #GMount.
* @flags: flags affecting the unmount if required for eject * @flags: flags affecting the unmount if required for eject
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback, or %NULL. * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
* @user_data: user data passed to @callback. * @user_data: user data passed to @callback.
* *
* Ejects a mount. This is an asynchronous operation, and is * Ejects a mount. This is an asynchronous operation, and is
@ -486,9 +486,10 @@ g_mount_eject_finish (GMount *mount,
* g_mount_unmount_with_operation: * g_mount_unmount_with_operation:
* @mount: a #GMount. * @mount: a #GMount.
* @flags: flags affecting the operation * @flags: flags affecting the operation
* @mount_operation: a #GMountOperation or %NULL to avoid user interaction. * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid
* @cancellable: optional #GCancellable object, %NULL to ignore. * user interaction.
* @callback: a #GAsyncReadyCallback, or %NULL. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
* @user_data: user data passed to @callback. * @user_data: user data passed to @callback.
* *
* Unmounts a mount. This is an asynchronous operation, and is * Unmounts a mount. This is an asynchronous operation, and is
@ -573,9 +574,10 @@ g_mount_unmount_with_operation_finish (GMount *mount,
* g_mount_eject_with_operation: * g_mount_eject_with_operation:
* @mount: a #GMount. * @mount: a #GMount.
* @flags: flags affecting the unmount if required for eject * @flags: flags affecting the unmount if required for eject
* @mount_operation: a #GMountOperation or %NULL to avoid user interaction. * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid
* @cancellable: optional #GCancellable object, %NULL to ignore. * user interaction.
* @callback: a #GAsyncReadyCallback, or %NULL. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
* @user_data: user data passed to @callback. * @user_data: user data passed to @callback.
* *
* Ejects a mount. This is an asynchronous operation, and is * Ejects a mount. This is an asynchronous operation, and is
@ -658,9 +660,10 @@ g_mount_eject_with_operation_finish (GMount *mount,
* g_mount_remount: * g_mount_remount:
* @mount: a #GMount. * @mount: a #GMount.
* @flags: flags affecting the operation * @flags: flags affecting the operation
* @mount_operation: a #GMountOperation or %NULL to avoid user interaction. * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid
* @cancellable: optional #GCancellable object, %NULL to ignore. * user interaction.
* @callback: a #GAsyncReadyCallback, or %NULL. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
* @user_data: user data passed to @callback. * @user_data: user data passed to @callback.
* *
* Remounts a mount. This is an asynchronous operation, and is * Remounts a mount. This is an asynchronous operation, and is
@ -741,7 +744,7 @@ g_mount_remount_finish (GMount *mount,
* @mount: a #GMount * @mount: a #GMount
* @force_rescan: Whether to force a rescan of the content. * @force_rescan: Whether to force a rescan of the content.
* Otherwise a cached result will be used if available * Otherwise a cached result will be used if available
* @cancellable: optional #GCancellable object, %NULL to ignore * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
* @callback: a #GAsyncReadyCallback * @callback: a #GAsyncReadyCallback
* @user_data: user data passed to @callback * @user_data: user data passed to @callback
* *
@ -831,7 +834,7 @@ g_mount_guess_content_type_finish (GMount *mount,
* @mount: a #GMount * @mount: a #GMount
* @force_rescan: Whether to force a rescan of the content. * @force_rescan: Whether to force a rescan of the content.
* Otherwise a cached result will be used if available * Otherwise a cached result will be used if available
* @cancellable: optional #GCancellable object, %NULL to ignore * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
* @error: a #GError location to store the error occuring, or %NULL to * @error: a #GError location to store the error occuring, or %NULL to
* ignore * ignore
* *

20
gio/gunixmounts.c
View File

@ -1075,15 +1075,16 @@ get_mount_points_timestamp (void)
} }
/** /**
* g_unix_mounts_get: * g_unix_mounts_get: (skip)
* @time_read: (allow-none): guint64 to contain a timestamp, or %NULL * @time_read: (out) (allow-none): guint64 to contain a timestamp, or %NULL
* *
* Gets a #GList of #GUnixMountEntry containing the unix mounts. * Gets a #GList of #GUnixMountEntry containing the unix mounts.
* If @time_read is set, it will be filled with the mount * If @time_read is set, it will be filled with the mount
* timestamp, allowing for checking if the mounts have changed * timestamp, allowing for checking if the mounts have changed
* with g_unix_mounts_changed_since(). * with g_unix_mounts_changed_since().
* *
* Returns: (element-type utf8) (transfer full): a #GList of the UNIX mounts. * Returns: (element-type GUnixMountEntry) (transfer full):
* a #GList of the UNIX mounts.
**/ **/
GList * GList *
g_unix_mounts_get (guint64 *time_read) g_unix_mounts_get (guint64 *time_read)
@ -1095,15 +1096,15 @@ g_unix_mounts_get (guint64 *time_read)
} }
/** /**
* g_unix_mount_at: * g_unix_mount_at: (skip)
* @mount_path: path for a possible unix mount. * @mount_path: path for a possible unix mount.
* @time_read: guint64 to contain a timestamp. * @time_read: (out) (allow-none): guint64 to contain a timestamp.
* *
* Gets a #GUnixMountEntry for a given mount path. If @time_read * Gets a #GUnixMountEntry for a given mount path. If @time_read
* is set, it will be filled with a unix timestamp for checking * is set, it will be filled with a unix timestamp for checking
* if the mounts have changed since with g_unix_mounts_changed_since(). * if the mounts have changed since with g_unix_mounts_changed_since().
* *
* Returns: (transfer full): a #GUnixMount. * Returns: (transfer full): a #GUnixMountEntry.
**/ **/
GUnixMountEntry * GUnixMountEntry *
g_unix_mount_at (const char *mount_path, g_unix_mount_at (const char *mount_path,
@ -1130,15 +1131,16 @@ g_unix_mount_at (const char *mount_path,
} }
/** /**
* g_unix_mount_points_get: * g_unix_mount_points_get: (skip)
* @time_read: (allow-none): guint64 to contain a timestamp. * @time_read: (out) (allow-none): guint64 to contain a timestamp.
* *
* Gets a #GList of #GUnixMountPoint containing the unix mount points. * Gets a #GList of #GUnixMountPoint containing the unix mount points.
* If @time_read is set, it will be filled with the mount timestamp, * If @time_read is set, it will be filled with the mount timestamp,
* allowing for checking if the mounts have changed with * allowing for checking if the mounts have changed with
* g_unix_mounts_points_changed_since(). * g_unix_mounts_points_changed_since().
* *
* Returns: (element-type utf8) (transfer full): a #GList of the UNIX mountpoints. * Returns: (element-type GUnixMountPoint) (transfer full):
* a #GList of the UNIX mountpoints.
**/ **/
GList * GList *
g_unix_mount_points_get (guint64 *time_read) g_unix_mount_points_get (guint64 *time_read)

13
gio/gvolume.c
View File

@ -301,8 +301,8 @@ g_volume_should_automount (GVolume *volume)
* @volume: a #GVolume. * @volume: a #GVolume.
* @flags: flags affecting the operation * @flags: flags affecting the operation
* @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid user interaction. * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid user interaction.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback, or %NULL. * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
* @user_data: user data that gets passed to @callback * @user_data: user data that gets passed to @callback
* *
* Mounts a volume. This is an asynchronous operation, and is * Mounts a volume. This is an asynchronous operation, and is
@ -378,8 +378,8 @@ g_volume_mount_finish (GVolume *volume,
* g_volume_eject: * g_volume_eject:
* @volume: a #GVolume. * @volume: a #GVolume.
* @flags: flags affecting the unmount if required for eject * @flags: flags affecting the unmount if required for eject
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback, or %NULL. * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
* @user_data: user data that gets passed to @callback * @user_data: user data that gets passed to @callback
* *
* Ejects a volume. This is an asynchronous operation, and is * Ejects a volume. This is an asynchronous operation, and is
@ -451,8 +451,9 @@ g_volume_eject_finish (GVolume *volume,
* g_volume_eject_with_operation: * g_volume_eject_with_operation:
* @volume: a #GVolume. * @volume: a #GVolume.
* @flags: flags affecting the unmount if required for eject * @flags: flags affecting the unmount if required for eject
* @mount_operation: a #GMountOperation or %NULL to avoid user interaction. * @mount_operation: (allow-none): a #GMountOperation or %NULL to
* @cancellable: optional #GCancellable object, %NULL to ignore. * avoid user interaction.
* @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback, or %NULL. * @callback: a #GAsyncReadyCallback, or %NULL.
* @user_data: user data passed to @callback. * @user_data: user data passed to @callback.
* *