From 89b558077f97c630c5b26b3527a6c7d0515f1f2c Mon Sep 17 00:00:00 2001 From: Pavel Holejsovsky Date: Fri, 17 Dec 2010 16:24:33 +0100 Subject: [PATCH] [gi] Add annotations for GFile, G[File]{Input|Output|IO}Stream. Also make parameter names in virtual function declarations consistent to silent g-ir-scanner. --- gio/gfile.c | 183 ++++++++++++++++++++-------------------- gio/gfileinputstream.c | 8 +- gio/gfileinputstream.h | 2 +- gio/gfileiostream.c | 8 +- gio/gfileiostream.h | 2 +- gio/gfileoutputstream.h | 2 +- gio/ginputstream.c | 28 +++--- gio/giostream.c | 14 +-- gio/goutputstream.c | 36 ++++---- gio/goutputstream.h | 2 +- 10 files changed, 143 insertions(+), 142 deletions(-) diff --git a/gio/gfile.c b/gio/gfile.c index 4cfec8f2c..da3477b88 100644 --- a/gio/gfile.c +++ b/gio/gfile.c @@ -822,7 +822,7 @@ g_file_resolve_relative_path (GFile *file, * @file: input #GFile. * @attributes: an attribute query string. * @flags: a set of #GFileQueryInfoFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: #GError for error reporting. * * Gets the requested information about the files in a directory. The result @@ -884,9 +884,10 @@ g_file_enumerate_children (GFile *file, * @flags: a set of #GFileQueryInfoFlags. * @io_priority: the I/O priority * of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the + * request is satisfied + * @user_data: (closure): the data to pass to callback function * * Asynchronously gets the requested information about the files in a directory. The result * is a #GFileEnumerator object that will give out #GFileInfo objects for @@ -957,7 +958,7 @@ g_file_enumerate_children_finish (GFile *file, /** * g_file_query_exists: * @file: input #GFile. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * * Utility function to check if a particular file exists. This is * implemented using g_file_query_info() and as such does blocking I/O. @@ -1007,7 +1008,7 @@ g_file_query_exists (GFile *file, * g_file_query_file_type: * @file: input #GFile. * @flags: a set of #GFileQueryInfoFlags passed to g_file_query_info(). - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * * Utility function to inspect the #GFileType of a file. This is * implemented using g_file_query_info() and as such does blocking I/O. @@ -1047,7 +1048,7 @@ g_file_query_file_type (GFile *file, * @file: input #GFile. * @attributes: an attribute query string. * @flags: a set of #GFileQueryInfoFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError. * * Gets the requested information about specified @file. The result @@ -1113,9 +1114,9 @@ g_file_query_info (GFile *file, * @flags: a set of #GFileQueryInfoFlags. * @io_priority: the I/O priority * of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Asynchronously gets the requested information about specified @file. The result * is a #GFileInfo object that contains key-value attributes (such as type or size @@ -1187,7 +1188,7 @@ g_file_query_info_finish (GFile *file, * g_file_query_filesystem_info: * @file: input #GFile. * @attributes: an attribute query string. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError. * * Similar to g_file_query_info(), but obtains information @@ -1247,9 +1248,9 @@ g_file_query_filesystem_info (GFile *file, * @attributes: an attribute query string. * @io_priority: the I/O priority * of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Asynchronously gets the requested information about the filesystem * that the specified @file is on. The result is a #GFileInfo object @@ -1320,7 +1321,7 @@ g_file_query_filesystem_info_finish (GFile *file, /** * g_file_find_enclosing_mount: * @file: input #GFile. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError. * * Gets a #GMount for the #GFile. @@ -1367,9 +1368,9 @@ g_file_find_enclosing_mount (GFile *file, * @file: a #GFile * @io_priority: the I/O priority * of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Asynchronously gets the mount for the file. * @@ -1435,7 +1436,7 @@ g_file_find_enclosing_mount_finish (GFile *file, /** * g_file_read: * @file: #GFile to read. - * @cancellable: a #GCancellable + * @cancellable: (allow-none): a #GCancellable * @error: a #GError, or %NULL * * Opens a file for reading. The result is a #GFileInputStream that @@ -1482,7 +1483,7 @@ g_file_read (GFile *file, * g_file_append_to: * @file: input #GFile. * @flags: a set of #GFileCreateFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Gets an output stream for appending data to the file. If @@ -1536,7 +1537,7 @@ g_file_append_to (GFile *file, * g_file_create: * @file: input #GFile. * @flags: a set of #GFileCreateFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Creates a new file and returns an output stream for writing to it. @@ -1596,7 +1597,7 @@ g_file_create (GFile *file, * current #GFile, or #NULL to ignore. * @make_backup: %TRUE if a backup should be created. * @flags: a set of #GFileCreateFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Returns an output stream for overwriting the file, possibly @@ -1680,7 +1681,7 @@ g_file_replace (GFile *file, /** * g_file_open_readwrite: * @file: #GFile to open - * @cancellable: a #GCancellable + * @cancellable: (allow-none): a #GCancellable * @error: a #GError, or %NULL * * Opens an existing file for reading and writing. The result is @@ -1731,7 +1732,7 @@ g_file_open_readwrite (GFile *file, * g_file_create_readwrite: * @file: a #GFile * @flags: a set of #GFileCreateFlags - * @cancellable: optional #GCancellable object, %NULL to ignore + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore * @error: return location for a #GError, or %NULL * * Creates a new file and returns a stream for reading and writing to it. @@ -1794,7 +1795,7 @@ g_file_create_readwrite (GFile *file, * current #GFile, or #NULL to ignore * @make_backup: %TRUE if a backup should be created * @flags: a set of #GFileCreateFlags - * @cancellable: optional #GCancellable object, %NULL to ignore + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore * @error: return location for a #GError, or %NULL * * Returns an output stream for overwriting the file in readwrite mode, @@ -1846,9 +1847,9 @@ g_file_replace_readwrite (GFile *file, * @file: input #GFile * @io_priority: the I/O priority * of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Asynchronously opens @file for reading. * @@ -1916,9 +1917,9 @@ g_file_read_finish (GFile *file, * @flags: a set of #GFileCreateFlags. * @io_priority: the I/O priority * of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Asynchronously opens @file for appending. * @@ -1988,9 +1989,9 @@ g_file_append_to_finish (GFile *file, * @flags: a set of #GFileCreateFlags. * @io_priority: the I/O priority * of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Asynchronously creates a new file and returns an output stream for writing to it. * The file must not already exist. @@ -2064,9 +2065,9 @@ g_file_create_finish (GFile *file, * @flags: a set of #GFileCreateFlags. * @io_priority: the I/O priority * of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Asynchronously overwrites the file, replacing the contents, possibly * creating a backup copy of the file first. @@ -2141,9 +2142,9 @@ g_file_replace_finish (GFile *file, * @file: input #GFile. * @io_priority: the I/O priority * of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Asynchronously opens @file for reading and writing. * @@ -2216,9 +2217,9 @@ g_file_open_readwrite_finish (GFile *file, * @flags: a set of #GFileCreateFlags * @io_priority: the I/O priority * of the request - * @cancellable: optional #GCancellable object, %NULL to ignore - * @callback: a #GAsyncReadyCallback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Asynchronously creates a new file and returns a stream for reading and * writing to it. The file must not already exist. @@ -2296,9 +2297,9 @@ g_file_create_readwrite_finish (GFile *file, * @flags: a set of #GFileCreateFlags. * @io_priority: the I/O priority * of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Asynchronously overwrites the file in read-write mode, replacing the * contents, possibly creating a backup copy of the file first. @@ -2570,7 +2571,7 @@ build_attribute_list_for_copy (GFileAttributeInfoList *attributes, * @source: a #GFile with attributes. * @destination: a #GFile to copy attributes to. * @flags: a set of #GFileCopyFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, %NULL to ignore. * * Copies the file attributes from @source to @destination. @@ -2988,7 +2989,7 @@ file_copy_fallback (GFile *source, * @source: input #GFile. * @destination: destination #GFile * @flags: set of #GFileCopyFlags - * @cancellable: 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_data: (closure): user data to pass to @progress_callback * @error: #GError to set on error, or %NULL @@ -3105,7 +3106,7 @@ g_file_copy (GFile *source, } /** - * g_file_copy_async: + * g_file_copy_async: (skip) * @source: input #GFile. * @destination: destination #GFile * @flags: set of #GFileCopyFlags @@ -3193,7 +3194,7 @@ g_file_copy_finish (GFile *file, * @source: #GFile pointing to the source location. * @destination: #GFile pointing to the destination location. * @flags: set of #GFileCopyFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @progress_callback: (scope call): #GFileProgressCallback function for updates. * @progress_callback_data: (closure): gpointer to user data for the callback function. * @error: #GError for returning error conditions, or %NULL @@ -3320,7 +3321,7 @@ g_file_move (GFile *source, /** * g_file_make_directory * @file: input #GFile. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Creates a directory. Note that this will only create a child directory of @@ -3368,7 +3369,7 @@ g_file_make_directory (GFile *file, /** * g_file_make_directory_with_parents: * @file: input #GFile. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Creates a directory and any parent directories that may not exist similar to @@ -3450,7 +3451,7 @@ g_file_make_directory_with_parents (GFile *file, * g_file_make_symbolic_link: * @file: a #GFile with the name of the symlink to create * @symlink_value: a string with the path for the target of the new symlink - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError. * * Creates a symbolic link named @file which contains the string @@ -3500,7 +3501,7 @@ g_file_make_symbolic_link (GFile *file, /** * g_file_delete: * @file: input #GFile. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Deletes a file. If the @file is a directory, it will only be deleted if it @@ -3541,7 +3542,7 @@ g_file_delete (GFile *file, /** * g_file_trash: * @file: #GFile to send to trash. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Sends @file to the "Trashcan", if possible. This is similar to @@ -3585,7 +3586,7 @@ g_file_trash (GFile *file, * g_file_set_display_name: * @file: input #GFile. * @display_name: a string. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Renames @file to the specified display name. @@ -3641,9 +3642,9 @@ g_file_set_display_name (GFile *file, * @display_name: a string. * @io_priority: the I/O priority * of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Asynchronously sets the display name for a given #GFile. * @@ -3711,7 +3712,7 @@ g_file_set_display_name_finish (GFile *file, /** * g_file_query_settable_attributes: * @file: input #GFile. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Obtain the list of settable attributes for the file. @@ -3767,7 +3768,7 @@ g_file_query_settable_attributes (GFile *file, /** * g_file_query_writable_namespaces: * @file: input #GFile. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Obtain the list of attribute namespaces where new attributes @@ -3824,7 +3825,7 @@ g_file_query_writable_namespaces (GFile *file, * @type: The type of the attribute * @value_p: a pointer to the value (or the pointer itself if the type is a pointer type) * @flags: a set of #GFileQueryInfoFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Sets an attribute in the file with attribute name @attribute to @value. @@ -3870,7 +3871,7 @@ g_file_set_attribute (GFile *file, * @file: input #GFile. * @info: a #GFileInfo. * @flags: #GFileQueryInfoFlags - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Tries to set all attributes in the #GFileInfo on the target values, @@ -3963,9 +3964,9 @@ g_file_real_set_attributes_from_info (GFile *file, * @flags: a #GFileQueryInfoFlags. * @io_priority: the I/O priority * of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback. - * @user_data: a #gpointer. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback. + * @user_data: (closure): a #gpointer. * * Asynchronously sets the attributes of @file with @info. * @@ -4034,7 +4035,7 @@ g_file_set_attributes_finish (GFile *file, * @attribute: a string containing the attribute's name. * @value: a string containing the attribute's value. * @flags: #GFileQueryInfoFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value. @@ -4065,7 +4066,7 @@ g_file_set_attribute_string (GFile *file, * @attribute: a string containing the attribute's name. * @value: a string containing the attribute's new value. * @flags: a #GFileQueryInfoFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value. @@ -4098,7 +4099,7 @@ g_file_set_attribute_byte_string (GFile *file, * @attribute: a string containing the attribute's name. * @value: a #guint32 containing the attribute's new value. * @flags: a #GFileQueryInfoFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value. @@ -4130,7 +4131,7 @@ g_file_set_attribute_uint32 (GFile *file, * @attribute: a string containing the attribute's name. * @value: a #gint32 containing the attribute's new value. * @flags: a #GFileQueryInfoFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value. @@ -4162,7 +4163,7 @@ g_file_set_attribute_int32 (GFile *file, * @attribute: a string containing the attribute's name. * @value: a #guint64 containing the attribute's new value. * @flags: a #GFileQueryInfoFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value. @@ -4194,7 +4195,7 @@ g_file_set_attribute_uint64 (GFile *file, * @attribute: a string containing the attribute's name. * @value: a #guint64 containing the attribute's new value. * @flags: a #GFileQueryInfoFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL * * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value. @@ -4224,9 +4225,9 @@ g_file_set_attribute_int64 (GFile *file, * @file: input #GFile. * @flags: flags affecting the operation * @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, or %NULL. - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL. + * @user_data: (closure): the data to pass to callback function * * Mounts a file of type G_FILE_TYPE_MOUNTABLE. * Using @mount_operation, you can request callbacks when, for instance, @@ -4311,9 +4312,9 @@ g_file_mount_mountable_finish (GFile *file, * g_file_unmount_mountable: * @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, or %NULL. - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL. + * @user_data: (closure): the data to pass to callback function * * Unmounts a file of type G_FILE_TYPE_MOUNTABLE. * @@ -4399,9 +4400,9 @@ g_file_unmount_mountable_finish (GFile *file, * @file: input #GFile. * @flags: flags affecting the operation * @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, or %NULL. - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL. + * @user_data: (closure): the data to pass to callback function * * Unmounts a file of type G_FILE_TYPE_MOUNTABLE. * @@ -4498,9 +4499,9 @@ g_file_unmount_mountable_with_operation_finish (GFile *file, * g_file_eject_mountable: * @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, or %NULL. - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL. + * @user_data: (closure): the data to pass to callback function * * Starts an asynchronous eject on a mountable. * When this operation has completed, @callback will be called with @@ -4584,9 +4585,9 @@ g_file_eject_mountable_finish (GFile *file, * @file: input #GFile. * @flags: flags affecting the operation * @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, or %NULL. - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL. + * @user_data: (closure): the data to pass to callback function * * Starts an asynchronous eject on a mountable. * When this operation has completed, @callback will be called with @@ -4681,7 +4682,7 @@ g_file_eject_mountable_with_operation_finish (GFile *file, * g_file_monitor_directory: * @file: input #GFile. * @flags: a set of #GFileMonitorFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL. * * Obtains a directory monitor for the given file. @@ -4725,7 +4726,7 @@ g_file_monitor_directory (GFile *file, * g_file_monitor_file: * @file: input #GFile. * @flags: a set of #GFileMonitorFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, or %NULL. * * Obtains a file monitor for the given file. If no file notification @@ -4770,7 +4771,7 @@ g_file_monitor_file (GFile *file, * g_file_monitor: * @file: input #GFile * @flags: a set of #GFileMonitorFlags - * @cancellable: optional #GCancellable object, %NULL to ignore + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore * @error: a #GError, or %NULL * * Obtains a file or directory monitor for the given file, depending @@ -6379,7 +6380,7 @@ load_contents_open_callback (GObject *obj, } /** - * g_file_load_partial_contents_async: + * g_file_load_partial_contents_async: (skip) * @file: input #GFile. * @cancellable: optional #GCancellable object, %NULL to ignore. * @read_more_callback: a #GFileReadMoreCallback to receive partial data and to specify whether further data should be read. diff --git a/gio/gfileinputstream.c b/gio/gfileinputstream.c index 685d768d0..42942b44e 100644 --- a/gio/gfileinputstream.c +++ b/gio/gfileinputstream.c @@ -112,7 +112,7 @@ g_file_input_stream_init (GFileInputStream *stream) * g_file_input_stream_query_info: * @stream: a #GFileInputStream. * @attributes: a file attribute query string. - * @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 * ignore. * @@ -180,9 +180,9 @@ async_ready_callback_wrapper (GObject *source_object, * @attributes: a file attribute query string. * @io_priority: the I/O priority * of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: callback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): callback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Queries the stream information asynchronously. * When the operation is finished @callback will be called. diff --git a/gio/gfileinputstream.h b/gio/gfileinputstream.h index 3c162c7f9..08c056e1b 100644 --- a/gio/gfileinputstream.h +++ b/gio/gfileinputstream.h @@ -79,7 +79,7 @@ struct _GFileInputStreamClass GAsyncReadyCallback callback, gpointer user_data); GFileInfo * (* query_info_finish) (GFileInputStream *stream, - GAsyncResult *res, + GAsyncResult *result, GError **error); /*< private >*/ diff --git a/gio/gfileiostream.c b/gio/gfileiostream.c index 1e5f17ff1..85a8dd909 100644 --- a/gio/gfileiostream.c +++ b/gio/gfileiostream.c @@ -115,7 +115,7 @@ g_file_io_stream_init (GFileIOStream *stream) * g_file_io_stream_query_info: * @stream: a #GFileIOStream. * @attributes: a file attribute query string. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: a #GError, %NULL to ignore. * * Queries a file io stream for the given @attributes. @@ -196,9 +196,9 @@ async_ready_callback_wrapper (GObject *source_object, * @attributes: a file attribute query string. * @io_priority: the I/O priority * of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: callback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): callback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Asynchronously queries the @stream for a #GFileInfo. When completed, * @callback will be called with a #GAsyncResult which can be used to diff --git a/gio/gfileiostream.h b/gio/gfileiostream.h index 09c99224b..31497e38c 100644 --- a/gio/gfileiostream.h +++ b/gio/gfileiostream.h @@ -84,7 +84,7 @@ struct _GFileIOStreamClass GAsyncReadyCallback callback, gpointer user_data); GFileInfo * (* query_info_finish) (GFileIOStream *stream, - GAsyncResult *res, + GAsyncResult *result, GError **error); char * (* get_etag) (GFileIOStream *stream); diff --git a/gio/gfileoutputstream.h b/gio/gfileoutputstream.h index b2c27f5c4..3b5f85d3b 100644 --- a/gio/gfileoutputstream.h +++ b/gio/gfileoutputstream.h @@ -84,7 +84,7 @@ struct _GFileOutputStreamClass GAsyncReadyCallback callback, gpointer user_data); GFileInfo * (* query_info_finish) (GFileOutputStream *stream, - GAsyncResult *res, + GAsyncResult *result, GError **error); char * (* get_etag) (GFileOutputStream *stream); diff --git a/gio/ginputstream.c b/gio/ginputstream.c index 3071a4743..53e84a042 100644 --- a/gio/ginputstream.c +++ b/gio/ginputstream.c @@ -139,7 +139,7 @@ g_input_stream_init (GInputStream *stream) * @stream: a #GInputStream. * @buffer: a buffer to read data into (which should be at least count bytes long). * @count: the number of bytes that will be read from the stream - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: location to store the error occuring, or %NULL to ignore * * Tries to read @count bytes from the stream into the buffer starting at @@ -216,8 +216,8 @@ g_input_stream_read (GInputStream *stream, * @stream: a #GInputStream. * @buffer: a buffer to read data into (which should be at least count bytes long). * @count: the number of bytes that will be read from the stream - * @bytes_read: location to store the number of bytes that was read from the stream - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @bytes_read: (out): location to store the number of bytes that was read from the stream + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: location to store the error occuring, or %NULL to ignore * * Tries to read @count bytes from the stream into the buffer starting at @@ -277,7 +277,7 @@ g_input_stream_read_all (GInputStream *stream, * g_input_stream_skip: * @stream: a #GInputStream. * @count: the number of bytes that will be skipped from the stream - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: location to store the error occuring, or %NULL to ignore * * Tries to skip @count bytes from the stream. Will block during the operation. @@ -393,7 +393,7 @@ g_input_stream_real_skip (GInputStream *stream, /** * g_input_stream_close: * @stream: A #GInputStream. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: location to store the error occuring, or %NULL to ignore * * Closes the stream, releasing resources related to it. @@ -492,9 +492,9 @@ async_ready_close_callback_wrapper (GObject *source_object, * @count: the number of bytes that will be read from the stream * @io_priority: the I/O priority * of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: callback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): callback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Request an asynchronous read of @count bytes from the stream into the buffer * starting at @buffer. When the operation is finished @callback will be called. @@ -617,9 +617,9 @@ g_input_stream_read_finish (GInputStream *stream, * @count: the number of bytes that will be skipped from the stream * @io_priority: the I/O priority * of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: callback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): callback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Request an asynchronous skip of @count bytes from the stream. * When the operation is finished @callback will be called. @@ -740,9 +740,9 @@ g_input_stream_skip_finish (GInputStream *stream, * @stream: A #GInputStream. * @io_priority: the I/O priority * of the request. - * @cancellable: optional cancellable object - * @callback: callback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional cancellable object + * @callback: (scope async): callback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Requests an asynchronous closes of the stream, releasing resources related to it. * When the operation is finished @callback will be called. diff --git a/gio/giostream.c b/gio/giostream.c index 5ff667455..db3cd92d2 100644 --- a/gio/giostream.c +++ b/gio/giostream.c @@ -361,7 +361,7 @@ g_io_stream_real_close (GIOStream *stream, /** * g_io_stream_close: * @stream: a #GIOStream - * @cancellable: optional #GCancellable object, %NULL to ignore + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore * @error: location to store the error occuring, or %NULL to ignore * * Closes the stream, releasing resources related to it. This will also @@ -454,9 +454,9 @@ async_ready_close_callback_wrapper (GObject *source_object, * g_io_stream_close_async: * @stream: a #GIOStream * @io_priority: the io priority of the request - * @callback: callback to call when the request is satisfied - * @user_data: the data to pass to callback function - * @cancellable: optional cancellable object + * @cancellable: (allow-none): optional cancellable object + * @callback: (scope async): callback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Requests an asynchronous close of the stream, releasing resources * related to it. When the operation is finished @callback will be @@ -755,9 +755,9 @@ splice_cancelled_cb (GCancellable *cancellable, * @stream2: a #GIOStream. * @flags: a set of #GIOStreamSpliceFlags. * @io_priority: the io priority of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback. - * @user_data: user data passed to @callback. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback. + * @user_data: (closure): user data passed to @callback. * * Asyncronously splice the output stream of @stream1 to the input stream of * @stream2, and splice the output stream of @stream2 to the input stream of diff --git a/gio/goutputstream.c b/gio/goutputstream.c index 5152de56c..02f013e41 100644 --- a/gio/goutputstream.c +++ b/gio/goutputstream.c @@ -150,7 +150,7 @@ g_output_stream_init (GOutputStream *stream) * @stream: a #GOutputStream. * @buffer: (array length=count) (element-type guint8): the buffer containing the data to write. * @count: the number of bytes to write - * @cancellable: optional cancellable object + * @cancellable: (allow-none): optional cancellable object * @error: location to store the error occuring, or %NULL to ignore * * Tries to write @count bytes from @buffer into the stream. Will block @@ -229,9 +229,9 @@ g_output_stream_write (GOutputStream *stream, * @stream: a #GOutputStream. * @buffer: (array length=count) (element-type guint8): the buffer containing the data to write. * @count: the number of bytes to write - * @bytes_written: location to store the number of bytes that was + * @bytes_written: (out): location to store the number of bytes that was * written to the stream - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: location to store the error occuring, or %NULL to ignore * * Tries to write @count bytes from @buffer into the stream. Will block @@ -290,7 +290,7 @@ g_output_stream_write_all (GOutputStream *stream, /** * g_output_stream_flush: * @stream: a #GOutputStream. - * @cancellable: optional cancellable object + * @cancellable: (allow-none): optional cancellable object * @error: location to store the error occuring, or %NULL to ignore * * Flushed any outstanding buffers in the stream. Will block during @@ -341,7 +341,7 @@ g_output_stream_flush (GOutputStream *stream, * @stream: a #GOutputStream. * @source: a #GInputStream. * @flags: a set of #GOutputStreamSpliceFlags. - * @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 * ignore. * @@ -468,7 +468,7 @@ g_output_stream_real_splice (GOutputStream *stream, /** * g_output_stream_close: * @stream: A #GOutputStream. - * @cancellable: optional cancellable object + * @cancellable: (allow-none): optional cancellable object * @error: location to store the error occuring, or %NULL to ignore * * Closes the stream, releasing resources related to it. @@ -655,9 +655,9 @@ async_ready_close_flushed_callback_wrapper (GObject *source_object, * @buffer: (array length=count) (element-type guint8): the buffer containing the data to write. * @count: the number of bytes to write * @io_priority: the io priority of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: callback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): callback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Request an asynchronous write of @count bytes from @buffer into * the stream. When the operation is finished @callback will be called. @@ -812,9 +812,9 @@ async_ready_splice_callback_wrapper (GObject *source_object, * @source: a #GInputStream. * @flags: a set of #GOutputStreamSpliceFlags. * @io_priority: the io priority of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback. - * @user_data: user data passed to @callback. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback. + * @user_data: (closure): user data passed to @callback. * * Splices a stream asynchronously. * When the operation is finished @callback will be called. @@ -908,9 +908,9 @@ g_output_stream_splice_finish (GOutputStream *stream, * g_output_stream_flush_async: * @stream: a #GOutputStream. * @io_priority: the io priority of the request. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback to call when the request is satisfied - * @user_data: the data to pass to callback function + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Flushes a stream asynchronously. * For behaviour details see g_output_stream_flush(). @@ -1003,9 +1003,9 @@ g_output_stream_flush_finish (GOutputStream *stream, * g_output_stream_close_async: * @stream: A #GOutputStream. * @io_priority: the io priority of the request. - * @callback: callback to call when the request is satisfied - * @user_data: the data to pass to callback function - * @cancellable: optional cancellable object + * @cancellable: (allow-none): optional cancellable object + * @callback: (scope async): callback to call when the request is satisfied + * @user_data: (closure): the data to pass to callback function * * Requests an asynchronous close of the stream, releasing resources * related to it. When the operation is finished @callback will be diff --git a/gio/goutputstream.h b/gio/goutputstream.h index e28bded85..995d0dd44 100644 --- a/gio/goutputstream.h +++ b/gio/goutputstream.h @@ -100,7 +100,7 @@ struct _GOutputStreamClass int io_priority, GCancellable *cancellable, GAsyncReadyCallback callback, - gpointer data); + gpointer user_data); gssize (* splice_finish) (GOutputStream *stream, GAsyncResult *result, GError **error);