luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-14 11:38:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

GFile: Add some introspection annotations

Browse Source 
progress_callback in g_file_copy and g_file_copy_async may be NULL.
Annotations should reflect that. Pointed out by Carlo Teubner.

https://bugzilla.gnome.org/show_bug.cgi?id=664415
This commit is contained in:
Matthias Clasen 2011-11-20 15:12:05 -05:00
parent ff2f4a12ee
commit 0878f5ba43
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
gio/gfile.c
View File

@ -2988,8 +2988,9 @@ file_copy_fallback (GFile *source,
* @source: input #GFile. * @source: input #GFile.
* @destination: destination #GFile * @destination: destination #GFile
* @flags: set of #GFileCopyFlags * @flags: set of #GFileCopyFlags
* @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
* @progress_callback: (scope call): function to callback with progress information * @progress_callback: (allow-none) (scope call): function to callback with
* progress information, or %NULL if progress information is not needed
* @progress_callback_data: (closure): user data to pass to @progress_callback * @progress_callback_data: (closure): user data to pass to @progress_callback
* @error: #GError to set on error, or %NULL * @error: #GError to set on error, or %NULL
* *
@ -3005,14 +3006,14 @@ file_copy_fallback (GFile *source,
* *
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation * triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
* *
* If @progress_callback is not %NULL, then the operation can be monitored by * If @progress_callback is not %NULL, then the operation can be monitored by
* setting this to a #GFileProgressCallback function. @progress_callback_data * setting this to a #GFileProgressCallback function. @progress_callback_data
* will be passed to this function. It is guaranteed that this callback will * will be passed to this function. It is guaranteed that this callback will
* be called after all data has been transferred with the total number of bytes * be called after all data has been transferred with the total number of bytes
* copied during the operation. * copied during the operation.
* *
* If the @source file does not exist then the G_IO_ERROR_NOT_FOUND * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
* error is returned, independent on the status of the @destination. * error is returned, independent on the status of the @destination.
* *
@ -3023,9 +3024,9 @@ file_copy_fallback (GFile *source,
* error is returned. If trying to overwrite a directory with a directory the * error is returned. If trying to overwrite a directory with a directory the
* G_IO_ERROR_WOULD_MERGE error is returned. * G_IO_ERROR_WOULD_MERGE error is returned.
* *
* If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is * If the source is a directory and the target does not exist, or
* specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then the
* is returned. * G_IO_ERROR_WOULD_RECURSE error is returned.
* *
* If you are interested in copying the #GFile object itself (not the on-disk * If you are interested in copying the #GFile object itself (not the on-disk
* file), see g_file_dup(). * file), see g_file_dup().
@ -3109,15 +3110,16 @@ g_file_copy (GFile *source,
* @source: input #GFile. * @source: input #GFile.
* @destination: destination #GFile * @destination: destination #GFile
* @flags: set of #GFileCopyFlags * @flags: set of #GFileCopyFlags
* @io_priority: the <link linkend="io-priority">I/O priority</link> * @io_priority: the <link linkend="io-priority">I/O priority</link>
* of the request. * of the request
* @cancellable: optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
* @progress_callback: function to callback with progress information * @progress_callback: (allow-none): function to callback with progress
* @progress_callback_data: user data to pass to @progress_callback * information, or %NULL if progress information is not needed
* @progress_callback_data: (closure): user data to pass to @progress_callback
* @callback: a #GAsyncReadyCallback to call when the request is satisfied * @callback: a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: the data to pass to callback function * @user_data: the data to pass to callback function
* *
* Copies the file @source to the location specified by @destination * Copies the file @source to the location specified by @destination
* asynchronously. For details of the behaviour, see g_file_copy(). * asynchronously. For details of the behaviour, see g_file_copy().
* *
* If @progress_callback is not %NULL, then that function that will be called * If @progress_callback is not %NULL, then that function that will be called