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

diff --git a/gio/ChangeLog b/gio/ChangeLog
index b893318dae21a5282b3b15b81f75f554aea64539..99abddd7ef3e573303086f9735b0ad6653155e7e 100644 (file)
--- a/gio/ChangeLog
+++ b/gio/ChangeLog
@@ -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>
 
         * gmemoryinputstream.c:

diff --git a/gio/gdrive.c b/gio/gdrive.c
index ca792910102ddef9e83528e743ca977c7dadc840..22616fbbbb91d25eed6fb10a0cdd58f0241f77b0 100644 (file)
--- a/gio/gdrive.c
+++ b/gio/gdrive.c
@@ -343,7 +343,7 @@ g_drive_can_poll_for_media (GDrive *drive)
  * @drive: a #GDrive.
  * @flags: flags affecting the unmount if required for eject
  * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @callback: a #GAsyncReadyCallback.
+ * @callback: a #GAsyncReadyCallback, or %NULL.
  * @user_data: a #gpointer.
  * 
  * Ejects a drive.
@@ -411,7 +411,7 @@ g_drive_eject_finish (GDrive        *drive,
  * g_drive_poll_for_media:
  * @drive: a #GDrive.
  * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @callback: a #GAsyncReadyCallback.
+ * @callback: a #GAsyncReadyCallback, or %NULL.
  * @user_data: a #gpointer.
  * 
  * Polls @drive to see if media has been inserted or removed.

diff --git a/gio/gfile.c b/gio/gfile.c
index 309c1ecf511389854a87f356a6349fd9736a285c..84611ce7cfed1da950ce17841aa3ce48ad57cddb 100644 (file)
--- a/gio/gfile.c
+++ b/gio/gfile.c
@@ -3010,7 +3010,7 @@ g_file_set_attribute_int64 (GFile                *file,
  * @file: input #GFile.
  * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
  * @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
  * 
  * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
@@ -3091,7 +3091,7 @@ g_file_mount_mountable_finish (GFile         *file,
  * @file: input #GFile.
  * @flags: flags affecting the operation
  * @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
  *
  * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
@@ -3171,7 +3171,7 @@ g_file_unmount_mountable_finish (GFile         *file,
  * @file: input #GFile.
  * @flags: flags affecting the operation
  * @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
  * 
  * Starts an asynchronous eject on a mountable.  
@@ -4034,7 +4034,7 @@ g_file_new_for_commandline_arg (const char *arg)
  * @location: input #GFile.
  * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
  * @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
  * 
  * Starts a @mount_operation, mounting the volume that contains the file @location. 

diff --git a/gio/gmount.c b/gio/gmount.c
index 8c0e0d174384b798b1ce812fa093cc81c92ab435..54f7e1d1471c91807ed3f4935c270cdd67cfe2b0 100644 (file)
--- a/gio/gmount.c
+++ b/gio/gmount.c
@@ -313,7 +313,7 @@ g_mount_can_eject (GMount *mount)
  * @mount: a #GMount.
  * @flags: flags affecting the operation
  * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @callback: a #GAsyncReadyCallback.
+ * @callback: a #GAsyncReadyCallback, or %NULL.
  * @user_data: user data passed to @callback.
  * 
  * Unmounts a mount. This is an asynchronous operation, and is 
@@ -385,7 +385,7 @@ g_mount_unmount_finish (GMount       *mount,
  * @mount: a #GMount.
  * @flags: flags affecting the unmount if required for eject
  * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @callback: a #GAsyncReadyCallback.
+ * @callback: a #GAsyncReadyCallback, or %NULL.
  * @user_data: user data passed to @callback.
  * 
  * Ejects a mount. This is an asynchronous operation, and is 
@@ -456,7 +456,7 @@ g_mount_eject_finish (GMount       *mount,
  * @mount: a #GMount.
  * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
  * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @callback: a #GAsyncReadyCallback.
+ * @callback: a #GAsyncReadyCallback, or %NULL.
  * @user_data: user data passed to @callback.
  * 
  * Remounts a mount. This is an asynchronous operation, and is 

diff --git a/gio/gvolume.c b/gio/gvolume.c
index 5eb1e49e4ddc4f7f7c483fa0f868cb87cc839ef6..3ccd0cdf35ba36ce33f7bff01a1aa6e7c0780966 100644 (file)
--- a/gio/gvolume.c
+++ b/gio/gvolume.c
@@ -293,7 +293,7 @@ g_volume_can_eject (GVolume *volume)
  * @volume: a #GVolume.
  * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
  * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @callback: a #GAsyncReadyCallback.
+ * @callback: a #GAsyncReadyCallback, or %NULL.
  * @user_data: a #gpointer.
  * 
  * Mounts a volume.
@@ -359,7 +359,7 @@ g_volume_mount_finish (GVolume  *volume,
  * @volume: a #GVolume.
  * @flags: flags affecting the unmount if required for eject
  * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @callback: a #GAsyncReadyCallback.
+ * @callback: a #GAsyncReadyCallback, or %NULL.
  * @user_data: a #gpointer.
  * 
  * Ejects a volume.