For async functions that have no non-async version, document that the

2008-01-15  Murray Cumming  <murrayc@murrayc.com>

* gdrive.c:
* gfile.c:
* gmount.c:
* gvolume.c: For async functions that have no non-async 
version, document that the GAsyncReadyCallback may be NULL.
Bug #509626.

svn path=/trunk/; revision=6318
This commit is contained in:
Murray Cumming 2008-01-15 14:08:41 +00:00 committed by Murray Cumming
parent 9d0f6b8f94
commit 218827445d
5 changed files with 20 additions and 11 deletions

View File

@ -1,3 +1,12 @@
2008-01-15 Murray Cumming <murrayc@murrayc.com>
* gdrive.c:
* gfile.c:
* gmount.c:
* gvolume.c: For async functions that have no non-async
version, document that the GAsyncReadyCallback may be NULL.
Bug #509626.
2008-01-15 Alexander Larsson <alexl@redhat.com> 2008-01-15 Alexander Larsson <alexl@redhat.com>
* gmemoryinputstream.c: * gmemoryinputstream.c:

View File

@ -343,7 +343,7 @@ g_drive_can_poll_for_media (GDrive *drive)
* @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: optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback. * @callback: a #GAsyncReadyCallback, or %NULL.
* @user_data: a #gpointer. * @user_data: a #gpointer.
* *
* Ejects a drive. * Ejects a drive.
@ -411,7 +411,7 @@ g_drive_eject_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: optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback. * @callback: a #GAsyncReadyCallback, or %NULL.
* @user_data: a #gpointer. * @user_data: a #gpointer.
* *
* Polls @drive to see if media has been inserted or removed. * Polls @drive to see if media has been inserted or removed.

View File

@ -3010,7 +3010,7 @@ g_file_set_attribute_int64 (GFile *file,
* @file: input #GFile. * @file: input #GFile.
* @mount_operation: a #GMountOperation, or %NULL to avoid user interaction. * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback to call when the request is satisfied * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
* @user_data: the data to pass to callback function * @user_data: the data to pass to callback function
* *
* Mounts a file of type G_FILE_TYPE_MOUNTABLE. * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
@ -3091,7 +3091,7 @@ g_file_mount_mountable_finish (GFile *file,
* @file: input #GFile. * @file: input #GFile.
* @flags: flags affecting the operation * @flags: flags affecting the operation
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback to call when the request is satisfied * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
* @user_data: the data to pass to callback function * @user_data: the data to pass to callback function
* *
* Unmounts a file of type G_FILE_TYPE_MOUNTABLE. * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
@ -3171,7 +3171,7 @@ g_file_unmount_mountable_finish (GFile *file,
* @file: input #GFile. * @file: input #GFile.
* @flags: flags affecting the operation * @flags: flags affecting the operation
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback to call when the request is satisfied * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
* @user_data: the data to pass to callback function * @user_data: the data to pass to callback function
* *
* Starts an asynchronous eject on a mountable. * Starts an asynchronous eject on a mountable.
@ -4034,7 +4034,7 @@ g_file_new_for_commandline_arg (const char *arg)
* @location: input #GFile. * @location: input #GFile.
* @mount_operation: a #GMountOperation or %NULL to avoid user interaction. * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback to call when the request is satisfied * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
* @user_data: the data to pass to callback function * @user_data: the data to pass to callback function
* *
* Starts a @mount_operation, mounting the volume that contains the file @location. * Starts a @mount_operation, mounting the volume that contains the file @location.

View File

@ -313,7 +313,7 @@ g_mount_can_eject (GMount *mount)
* @mount: a #GMount. * @mount: a #GMount.
* @flags: flags affecting the operation * @flags: flags affecting the operation
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback. * @callback: 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
@ -385,7 +385,7 @@ g_mount_unmount_finish (GMount *mount,
* @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: optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback. * @callback: 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
@ -456,7 +456,7 @@ g_mount_eject_finish (GMount *mount,
* @mount: a #GMount. * @mount: a #GMount.
* @mount_operation: a #GMountOperation or %NULL to avoid user interaction. * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback. * @callback: 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

View File

@ -293,7 +293,7 @@ g_volume_can_eject (GVolume *volume)
* @volume: a #GVolume. * @volume: a #GVolume.
* @mount_operation: a #GMountOperation or %NULL to avoid user interaction. * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback. * @callback: a #GAsyncReadyCallback, or %NULL.
* @user_data: a #gpointer. * @user_data: a #gpointer.
* *
* Mounts a volume. * Mounts a volume.
@ -359,7 +359,7 @@ g_volume_mount_finish (GVolume *volume,
* @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: optional #GCancellable object, %NULL to ignore.
* @callback: a #GAsyncReadyCallback. * @callback: a #GAsyncReadyCallback, or %NULL.
* @user_data: a #gpointer. * @user_data: a #gpointer.
* *
* Ejects a volume. * Ejects a volume.