diff options
author | Johan Dahlin <johan@gnome.org> | 2010-09-24 18:24:41 -0300 |
---|---|---|
committer | Johan Dahlin <jdahlin@litl.com> | 2010-09-24 18:24:41 -0300 |
commit | 30132c44c18d9a08e4c6a9b4834366bd8628ecfa (patch) | |
tree | 134ed0535fb314b82683da0b30a948e3d9a90214 | |
parent | 701ce5d2011ee4408212461f6e191eaca2290d0a (diff) |
Add a lot of missing annotations
61 files changed, 172 insertions, 161 deletions
diff --git a/gio/gaction.h b/gio/gaction.h index 5bf745624..292c71a09 100644 --- a/gio/gaction.h +++ b/gio/gaction.h @@ -66,7 +66,7 @@ struct _GActionInterface gboolean (* get_enabled) (GAction *action); GVariant * (* get_state) (GAction *action); void (* set_state) (GAction *action, - GVariant *state); + GVariant *value); void (* activate) (GAction *action, GVariant *parameter); diff --git a/gio/gappinfo.c b/gio/gappinfo.c index a95315817..2902f4a53 100644 --- a/gio/gappinfo.c +++ b/gio/gappinfo.c @@ -681,7 +681,8 @@ g_app_info_can_delete (GAppInfo *appinfo) * On some platforms, there may be a difference between user-defined * #GAppInfo<!-- -->s which can be deleted, and system-wide ones which * cannot. See g_app_info_can_delete(). - * + * + * Virtual: do_delete * Returns: %TRUE if @appinfo has been deleted * * Since: 2.20 diff --git a/gio/gasyncresult.c b/gio/gasyncresult.c index 9b2be2e92..aec48d6ff 100644 --- a/gio/gasyncresult.c +++ b/gio/gasyncresult.c @@ -122,7 +122,7 @@ g_async_result_default_init (GAsyncResultInterface *iface) * * Gets the user data from a #GAsyncResult. * - * Returns: the user data for @res. + * Returns: (transfer full): the user data for @res. **/ gpointer g_async_result_get_user_data (GAsyncResult *res) @@ -142,7 +142,7 @@ g_async_result_get_user_data (GAsyncResult *res) * * Gets the source object from a #GAsyncResult. * - * Returns: a new reference to the source object for the @res, + * Returns: (transfer full): a new reference to the source object for the @res, * or %NULL if there is none. */ GObject * diff --git a/gio/gcancellable.c b/gio/gcancellable.c index e757b8f48..3a9953299 100644 --- a/gio/gcancellable.c +++ b/gio/gcancellable.c @@ -333,7 +333,7 @@ g_cancellable_pop_current (GCancellable *cancellable) * * Gets the top cancellable from the stack. * - * Returns: a #GCancellable from the top of the stack, or %NULL + * Returns: (transfer none): a #GCancellable from the top of the stack, or %NULL * if the stack is empty. **/ GCancellable * diff --git a/gio/gcontenttype.c b/gio/gcontenttype.c index e745b275d..dfbe8688b 100644 --- a/gio/gcontenttype.c +++ b/gio/gcontenttype.c @@ -743,7 +743,7 @@ g_content_type_get_mime_type (const char *type) * * Gets the icon for a content type. * - * Returns: #GIcon corresponding to the content type. Free the returned + * Returns: (transfer full): #GIcon corresponding to the content type. Free the returned * object with g_object_unref() */ GIcon * @@ -1651,7 +1651,7 @@ match_match (TreeMatch *match, * This function is useful in the implementation of * g_mount_guess_content_type(). * - * Returns: an %NULL-terminated array of zero or more content types, + * Returns: (transfer full): an %NULL-terminated array of zero or more content types, * or %NULL. Free with g_strfreev() * * Since: 2.18 diff --git a/gio/gconverterinputstream.c b/gio/gconverterinputstream.c index 16b640bec..d81cd90f8 100644 --- a/gio/gconverterinputstream.c +++ b/gio/gconverterinputstream.c @@ -542,7 +542,7 @@ g_converter_input_stream_read (GInputStream *stream, * * Gets the #GConverter that is used by @converter_stream. * - * Returns: the converter of the converter input stream + * Returns: (transfer none): the converter of the converter input stream * * Since: 2.24 */ diff --git a/gio/gconverteroutputstream.c b/gio/gconverteroutputstream.c index 8c9b0b022..5b1cbec7e 100644 --- a/gio/gconverteroutputstream.c +++ b/gio/gconverteroutputstream.c @@ -602,7 +602,7 @@ g_converter_output_stream_flush (GOutputStream *stream, * * Gets the #GConverter that is used by @converter_stream. * - * Returns: the converter of the converter output stream + * Returns: (transfer none): the converter of the converter output stream * * Since: 2.24 */ diff --git a/gio/gcredentials.c b/gio/gcredentials.c index e2cc7ba7c..f54ea24aa 100644 --- a/gio/gcredentials.c +++ b/gio/gcredentials.c @@ -250,7 +250,7 @@ g_credentials_is_same_user (GCredentials *credentials, } /** - * g_credentials_get_native: + * g_credentials_get_native: (skip) * @credentials: A #GCredentials. * @native_type: The type of native credentials to get. * diff --git a/gio/gdbusaddress.c b/gio/gdbusaddress.c index 46d108a0d..59b55d38a 100644 --- a/gio/gdbusaddress.c +++ b/gio/gdbusaddress.c @@ -867,7 +867,7 @@ g_dbus_address_get_stream (const gchar *address, * * Finishes an operation started with g_dbus_address_get_stream(). * - * Returns: A #GIOStream or %NULL if @error is set. + * Returns: (transfer full): A #GIOStream or %NULL if @error is set. * * Since: 2.26 */ @@ -913,7 +913,7 @@ g_dbus_address_get_stream_finish (GAsyncResult *res, * This is a synchronous failable function. See * g_dbus_address_get_stream() for the asynchronous version. * - * Returns: A #GIOStream or %NULL if @error is set. + * Returns: (transfer full): A #GIOStream or %NULL if @error is set. * * Since: 2.26 */ diff --git a/gio/gdbusconnection.c b/gio/gdbusconnection.c index a4abc14dc..54665cc16 100644 --- a/gio/gdbusconnection.c +++ b/gio/gdbusconnection.c @@ -950,7 +950,7 @@ g_dbus_connection_init (GDBusConnection *connection) * * Gets the underlying stream used for IO. * - * Returns: the stream used for IO + * Returns: (transfer none): the stream used for IO * * Since: 2.26 */ @@ -1878,7 +1878,7 @@ g_dbus_connection_send_message_with_reply (GDBusConnection *connection, * linkend="gdbus-unix-fd-client"/> for an example of how to use this * low-level API to send and receive UNIX file descriptors. * - * Returns: A locked #GDBusMessage or %NULL if @error is set. + * Returns: (transfer full): A locked #GDBusMessage or %NULL if @error is set. * * Since: 2.26 */ @@ -1974,7 +1974,7 @@ send_message_with_reply_sync_cb (GDBusConnection *connection, * Note that @message must be unlocked, unless @flags contain the * %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag. * - * Returns: A locked #GDBusMessage that is the reply to @message or %NULL if @error is set. + * Returns: (transfer full): A locked #GDBusMessage that is the reply to @message or %NULL if @error is set. * * Since: 2.26 */ @@ -2802,7 +2802,7 @@ g_dbus_connection_get_unique_name (GDBusConnection *connection) * each application is a client. So this method will always return * %NULL for message bus clients. * - * Returns: A #GCredentials or %NULL if not available. Do not free + * Returns: (transfer none): A #GCredentials or %NULL if not available. Do not free * this object, it is owned by @connection. * * Since: 2.26 @@ -6236,7 +6236,7 @@ get_uninitialized_connection (GBusType bus_type, * Note that the returned #GDBusConnection object will (usually) have * the #GDBusConnection:exit-on-close property set to %TRUE. * - * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). + * Returns: (transfer full): A #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). * * Since: 2.26 */ @@ -6359,7 +6359,7 @@ g_bus_get (GBusType bus_type, * Note that the returned #GDBusConnection object will (usually) have * the #GDBusConnection:exit-on-close property set to %TRUE. * - * Returns: A #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). + * Returns: (transfer full): A #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). * * Since: 2.26 */ diff --git a/gio/gdbusmessage.c b/gio/gdbusmessage.c index 0aca1e01b..ade5e7be7 100644 --- a/gio/gdbusmessage.c +++ b/gio/gdbusmessage.c @@ -294,7 +294,7 @@ g_dbus_message_new_signal (const gchar *path, * * Creates a new #GDBusMessage that is a reply to @method_call_message. * - * Returns: A #GDBusMessage. Free with g_object_unref(). + * Returns: (transfer full): #GDBusMessage. Free with g_object_unref(). * * Since: 2.26 */ @@ -332,7 +332,7 @@ g_dbus_message_new_method_reply (GDBusMessage *method_call_message) * * Creates a new #GDBusMessage that is an error reply to @method_call_message. * - * Returns: A #GDBusMessage. Free with g_object_unref(). + * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref(). * * Since: 2.26 */ @@ -364,7 +364,7 @@ g_dbus_message_new_method_error (GDBusMessage *method_call_message, * * Creates a new #GDBusMessage that is an error reply to @method_call_message. * - * Returns: A #GDBusMessage. Free with g_object_unref(). + * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref(). * * Since: 2.26 */ @@ -409,7 +409,7 @@ g_dbus_message_new_method_error_literal (GDBusMessage *method_call_message, * * Like g_dbus_message_new_method_error() but intended for language bindings. * - * Returns: A #GDBusMessage. Free with g_object_unref(). + * Returns: (transfer full): A #GDBusMessage. Free with g_object_unref(). * * Since: 2.26 */ @@ -780,7 +780,7 @@ g_dbus_message_set_body (GDBusMessage *message, * * This method is only available on UNIX. * - * Returns: A #GUnixFDList or %NULL if no file descriptors are + * Returns: (transfer none):A #GUnixFDList or %NULL if no file descriptors are * associated. Do not free, this object is owned by @message. * * Since: 2.26 @@ -3195,7 +3195,7 @@ g_dbus_message_lock (GDBusMessage *message) * This operation can fail if e.g. @message contains file descriptors * and the per-process or system-wide open files limit is reached. * - * Returns: A new #GDBusMessage or %NULL if @error is set. Free with + * Returns: (transfer full): A new #GDBusMessage or %NULL if @error is set. Free with * g_object_unref(). * * Since: 2.26 diff --git a/gio/gdbusmethodinvocation.c b/gio/gdbusmethodinvocation.c index a84f92b70..2e6b5e695 100644 --- a/gio/gdbusmethodinvocation.c +++ b/gio/gdbusmethodinvocation.c @@ -210,7 +210,7 @@ g_dbus_method_invocation_get_method_name (GDBusMethodInvocation *invocation) * * Gets the #GDBusConnection the method was invoked on. * - * Returns: A #GDBusConnection. Do not free, it is owned by @invocation. + * Returns: (transfer none):A #GDBusConnection. Do not free, it is owned by @invocation. * * Since: 2.26 */ @@ -234,7 +234,7 @@ g_dbus_method_invocation_get_connection (GDBusMethodInvocation *invocation) * linkend="gdbus-unix-fd-client"/> for an example of how to use this * low-level API to send and receive UNIX file descriptors. * - * Returns: A #GDBusMessage. Do not free, it is owned by @invocation. + * Returns: (transfer none): #GDBusMessage. Do not free, it is owned by @invocation. * * Since: 2.26 */ @@ -263,7 +263,7 @@ g_dbus_method_invocation_get_parameters (GDBusMethodInvocation *invocation) } /** - * g_dbus_method_invocation_get_user_data: + * g_dbus_method_invocation_get_user_data: (skip) * @invocation: A #GDBusMethodInvocation. * * Gets the @user_data #gpointer passed to g_dbus_connection_register_object(). diff --git a/gio/gdbusproxy.c b/gio/gdbusproxy.c index d096a5a63..54185cec8 100644 --- a/gio/gdbusproxy.c +++ b/gio/gdbusproxy.c @@ -1905,7 +1905,7 @@ g_dbus_proxy_new_for_bus_sync (GBusType bus_type, * * Gets the connection @proxy is for. * - * Returns: A #GDBusConnection owned by @proxy. Do not free. + * Returns: (transfer none): A #GDBusConnection owned by @proxy. Do not free. * * Since: 2.26 */ diff --git a/gio/gdesktopappinfo.c b/gio/gdesktopappinfo.c index 0c0f8f23e..c38726c8b 100644 --- a/gio/gdesktopappinfo.c +++ b/gio/gdesktopappinfo.c @@ -2701,7 +2701,7 @@ g_desktop_app_info_lookup_default_init (GDesktopAppInfoLookupInterface *iface) * in a GIO module. There is no reason for applications to use it * directly. Applications should use g_app_info_get_default_for_uri_scheme(). * - * Returns: #GAppInfo for given @uri_scheme or %NULL on error. + * Returns: (transfer full): #GAppInfo for given @uri_scheme or %NULL on error. */ GAppInfo * g_desktop_app_info_lookup_get_default_for_uri_scheme (GDesktopAppInfoLookup *lookup, diff --git a/gio/gdrive.c b/gio/gdrive.c index af65339fb..5d6efdc0b 100644 --- a/gio/gdrive.c +++ b/gio/gdrive.c @@ -159,7 +159,7 @@ g_drive_get_name (GDrive *drive) * * Gets the icon for @drive. * - * Returns: #GIcon for the @drive. + * Returns: (transfer full): #GIcon for the @drive. * Free the returned object with g_object_unref(). **/ GIcon * @@ -594,7 +594,7 @@ g_drive_get_identifier (GDrive *drive, * Use g_drive_get_identifer() to obtain the identifiers * themselves. * - * Returns: a %NULL-terminated array of strings containing + * Returns: (transfer full): a %NULL-terminated array of strings containing * kinds of identifiers. Use g_strfreev() to free. */ char ** diff --git a/gio/gemblem.c b/gio/gemblem.c index 46a013779..68afbab76 100644 --- a/gio/gemblem.c +++ b/gio/gemblem.c @@ -220,7 +220,7 @@ g_emblem_new_with_origin (GIcon *icon, * * Gives back the icon from @emblem. * - * Returns: a #GIcon. The returned object belongs to the emblem + * Returns: (transfer full): a #GIcon. The returned object belongs to the emblem * and should not be modified or freed. * * Since: 2.18 diff --git a/gio/gemblemedicon.c b/gio/gemblemedicon.c index 5b5a158fa..af26c83c2 100644 --- a/gio/gemblemedicon.c +++ b/gio/gemblemedicon.c @@ -99,7 +99,7 @@ g_emblemed_icon_init (GEmblemedIcon *emblemed) * * Creates a new emblemed icon for @icon with the emblem @emblem. * - * Returns: a new #GIcon + * Returns: (transfer full): a new #GIcon * * Since: 2.18 **/ @@ -128,7 +128,7 @@ g_emblemed_icon_new (GIcon *icon, * * Gets the main icon for @emblemed. * - * Returns: a #GIcon that is owned by @emblemed + * Returns: (transfer full): a #GIcon that is owned by @emblemed * * Since: 2.18 **/ diff --git a/gio/gfile.c b/gio/gfile.c index dac697633..54b0725aa 100644 --- a/gio/gfile.c +++ b/gio/gfile.c @@ -542,7 +542,8 @@ g_file_dup (GFile *file) * Creates a hash value for a #GFile. * * This call does no blocking i/o. - * + * + * Virtual: hash * Returns: 0 if @file is not a valid #GFile, otherwise an * integer that can be used as hash value for the #GFile. * This function is intended for easily hashing a #GFile to @@ -603,7 +604,7 @@ g_file_equal (GFile *file1, * * This call does no blocking i/o. * - * Returns: a #GFile structure to the parent of the given + * Returns: (transfer full): a #GFile structure to the parent of the given * #GFile or %NULL if there is no parent. * Free the returned object with g_object_unref(). **/ @@ -736,6 +737,7 @@ g_file_get_child_for_display_name (GFile *file, * filesystem point of view), because the prefix of @file is an alias * of @prefix. * + * Virtual: prefix_matches * Returns: %TRUE if the @files's parent, grandparent, etc is @prefix. * %FALSE otherwise. **/ @@ -797,7 +799,7 @@ g_file_get_relative_path (GFile *parent, * * This call does no blocking i/o. * - * Returns: #GFile to the resolved path. %NULL if @relative_path + * Returns: (transfer full): #GFile to the resolved path. %NULL if @relative_path * is %NULL or if @file is invalid. * Free the returned object with g_object_unref(). **/ @@ -1074,7 +1076,7 @@ g_file_query_file_type (GFile *file, * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned. * Other errors are possible too, and depend on what kind of filesystem the file is on. * - * Returns: a #GFileInfo for the given @file, or %NULL on error. + * Returns: (transfer full): a #GFileInfo for the given @file, or %NULL on error. * Free the returned object with g_object_unref(). **/ GFileInfo * @@ -1157,7 +1159,7 @@ g_file_query_info_async (GFile *file, * Finishes an asynchronous file info query. * See g_file_query_info_async(). * - * Returns: #GFileInfo for given @file or %NULL on error. + * Returns: (transfer full): #GFileInfo for given @file or %NULL on error. * Free the returned object with g_object_unref(). **/ GFileInfo * @@ -1210,7 +1212,7 @@ g_file_query_info_finish (GFile *file, * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned. * Other errors are possible too, and depend on what kind of filesystem the file is on. * - * Returns: a #GFileInfo or %NULL if there was an error. + * Returns: (transfer full): a #GFileInfo or %NULL if there was an error. * Free the returned object with g_object_unref(). **/ GFileInfo * @@ -1291,7 +1293,7 @@ g_file_query_filesystem_info_async (GFile *file, * Finishes an asynchronous filesystem info query. See * g_file_query_filesystem_info_async(). * - * Returns: #GFileInfo for given @file or %NULL on error. + * Returns: (transfer full): #GFileInfo for given @file or %NULL on error. * Free the returned object with g_object_unref(). **/ GFileInfo * @@ -1331,7 +1333,7 @@ g_file_query_filesystem_info_finish (GFile *file, * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * Returns: a #GMount where the @file is located or %NULL on error. + * Returns: (transfer full): a #GMount where the @file is located or %NULL on error. * Free the returned object with g_object_unref(). **/ GMount * @@ -1405,7 +1407,7 @@ g_file_find_enclosing_mount_async (GFile *file, * Finishes an asynchronous find mount request. * See g_file_find_enclosing_mount_async(). * - * Returns: #GMount for given @file or %NULL on error. + * Returns: (transfer full): #GMount for given @file or %NULL on error. * Free the returned object with g_object_unref(). **/ GMount * @@ -1447,7 +1449,8 @@ g_file_find_enclosing_mount_finish (GFile *file, * If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned. * Other errors are possible too, and depend on what kind of filesystem the file is on. * - * Returns: #GFileInputStream or %NULL on error. + * Virtual: read_fn + * Returns: (transfer full): #GFileInputStream or %NULL on error. * Free the returned object with g_object_unref(). **/ GFileInputStream * @@ -1500,7 +1503,7 @@ g_file_read (GFile *file, * returned. Other errors are possible too, and depend on what kind of * filesystem the file is on. * - * Returns: a #GFileOutputStream, or %NULL on error. + * Returns: (transfer full): a #GFileOutputStream, or %NULL on error. * Free the returned object with g_object_unref(). **/ GFileOutputStream * @@ -1556,7 +1559,7 @@ g_file_append_to (GFile *file, * Other errors are possible too, and depend on what kind of * filesystem the file is on. * - * Returns: a #GFileOutputStream for the newly created file, or + * Returns: (transfer full): a #GFileOutputStream for the newly created file, or * %NULL on error. * Free the returned object with g_object_unref(). **/ @@ -1638,7 +1641,7 @@ g_file_create (GFile *file, * Other errors are possible too, and depend on what kind of * filesystem the file is on. * - * Returns: a #GFileOutputStream or %NULL on error. + * Returns: (transfer full): a #GFileOutputStream or %NULL on error. * Free the returned object with g_object_unref(). **/ GFileOutputStream * @@ -1694,7 +1697,7 @@ g_file_replace (GFile *file, * so make sure you really need to do read and write streaming, rather than * just opening for reading or writing. * - * Returns: #GFileIOStream or %NULL on error. + * Returns: (transfer full): #GFileIOStream or %NULL on error. * Free the returned object with g_object_unref(). * * Since: 2.22 @@ -1753,7 +1756,7 @@ g_file_open_readwrite (GFile *file, * supported, so make sure you really need to do read and write streaming, * rather than just opening for reading or writing. * - * Returns: a #GFileIOStream for the newly created file, or %NULL on error. + * Returns: (transfer full): a #GFileIOStream for the newly created file, or %NULL on error. * Free the returned object with g_object_unref(). * * Since: 2.22 @@ -1805,7 +1808,7 @@ g_file_create_readwrite (GFile *file, * supported, so make sure you really need to do read and write streaming, * rather than just opening for reading or writing. * - * Returns: a #GFileIOStream or %NULL on error. + * Returns: (transfer full): a #GFileIOStream or %NULL on error. * Free the returned object with g_object_unref(). * * Since: 2.22 @@ -1883,7 +1886,7 @@ g_file_read_async (GFile *file, * Finishes an asynchronous file read operation started with * g_file_read_async(). * - * Returns: a #GFileInputStream or %NULL on error. + * Returns: (transfer full): a #GFileInputStream or %NULL on error. * Free the returned object with g_object_unref(). **/ GFileInputStream * @@ -1955,7 +1958,7 @@ g_file_append_to_async (GFile *file, * Finishes an asynchronous file append operation started with * g_file_append_to_async(). * - * Returns: a valid #GFileOutputStream or %NULL on error. + * Returns: (transfer full): a valid #GFileOutputStream or %NULL on error. * Free the returned object with g_object_unref(). **/ GFileOutputStream * @@ -2028,7 +2031,7 @@ g_file_create_async (GFile *file, * Finishes an asynchronous file create operation started with * g_file_create_async(). * - * Returns: a #GFileOutputStream or %NULL on error. + * Returns: (transfer full): a #GFileOutputStream or %NULL on error. * Free the returned object with g_object_unref(). **/ GFileOutputStream * @@ -2108,7 +2111,7 @@ g_file_replace_async (GFile *file, * Finishes an asynchronous file replace operation started with * g_file_replace_async(). * - * Returns: a #GFileOutputStream, or %NULL on error. + * Returns: (transfer full): a #GFileOutputStream, or %NULL on error. * Free the returned object with g_object_unref(). **/ GFileOutputStream * @@ -2180,7 +2183,7 @@ g_file_open_readwrite_async (GFile *file, * Finishes an asynchronous file read operation started with * g_file_open_readwrite_async(). * - * Returns: a #GFileIOStream or %NULL on error. + * Returns: (transfer full): a #GFileIOStream or %NULL on error. * Free the returned object with g_object_unref(). * * Since: 2.22 @@ -2258,7 +2261,7 @@ g_file_create_readwrite_async (GFile *file, * Finishes an asynchronous file create operation started with * g_file_create_readwrite_async(). * - * Returns: a #GFileIOStream or %NULL on error. + * Returns: (transfer full): a #GFileIOStream or %NULL on error. * Free the returned object with g_object_unref(). * * Since: 2.22 @@ -2342,7 +2345,7 @@ g_file_replace_readwrite_async (GFile *file, * Finishes an asynchronous file replace operation started with * g_file_replace_readwrite_async(). * - * Returns: a #GFileIOStream, or %NULL on error. + * Returns: (transfer full): a #GFileIOStream, or %NULL on error. * Free the returned object with g_object_unref(). * * Since: 2.22 @@ -3506,7 +3509,8 @@ g_file_make_symbolic_link (GFile *file, * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * + * + * Virtual: delete_file * Returns: %TRUE if the file was deleted. %FALSE otherwise. **/ gboolean @@ -3599,7 +3603,7 @@ g_file_trash (GFile *file, * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * Returns: a #GFile specifying what @file was renamed to, or %NULL + * Returns: (transfer full): a #GFile specifying what @file was renamed to, or %NULL * if there was an error. * Free the returned object with g_object_unref(). **/ @@ -3680,7 +3684,7 @@ g_file_set_display_name_async (GFile *file, * Finishes setting a display name started with * g_file_set_display_name_async(). * - * Returns: a #GFile or %NULL on error. + * Returns: (transfer full): a #GFile or %NULL on error. * Free the returned object with g_object_unref(). **/ GFile * @@ -4279,7 +4283,7 @@ g_file_mount_mountable (GFile *file, * Finish an asynchronous mount operation that was started * with g_file_mount_mountable(). * - * Returns: a #GFile or %NULL on error. + * Returns: (transfer full): a #GFile or %NULL on error. * Free the returned object with g_object_unref(). **/ GFile * @@ -4686,8 +4690,9 @@ g_file_eject_mountable_with_operation_finish (GFile *file, * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * - * Returns: a #GFileMonitor for the given @file, or %NULL on error. + * + * Virtual: monitor_dir + * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error. * Free the returned object with g_object_unref(). **/ GFileMonitor* @@ -4775,7 +4780,7 @@ g_file_monitor_file (GFile *file, * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * Returns: a #GFileMonitor for the given @file, or %NULL on error. + * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error. * Free the returned object with g_object_unref(). * * Since: 2.18 @@ -6097,7 +6102,7 @@ g_file_mount_enclosing_volume_finish (GFile *location, * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * Returns: a #GAppInfo if the handle was found, %NULL if there were errors. + * Returns: (transfer full): a #GAppInfo if the handle was found, %NULL if there were errors. * When you are done with it, release it with g_object_unref() **/ GAppInfo * diff --git a/gio/gfileenumerator.c b/gio/gfileenumerator.c index b048d6598..8c01a87b9 100644 --- a/gio/gfileenumerator.c +++ b/gio/gfileenumerator.c @@ -390,7 +390,7 @@ g_file_enumerator_next_files_async (GFileEnumerator *enumerator, * * Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). * - * Returns: (transfer full) (element-type FileInfo): a #GList of #GFileInfo<!---->s. You must free the list with + * Returns: (transfer full) (element-type Gio.FileInfo): a #GList of #GFileInfo<!---->s. You must free the list with * g_list_free() and unref the infos with g_object_unref() when you're * done with them. **/ diff --git a/gio/gfileicon.c b/gio/gfileicon.c index 0f22b2324..10170402e 100644 --- a/gio/gfileicon.c +++ b/gio/gfileicon.c @@ -158,7 +158,7 @@ g_file_icon_init (GFileIcon *file) * * Creates a new icon for a file. * - * Returns: a #GIcon for the given @file, or %NULL on error. + * Returns: (transfer full): a #GIcon for the given @file, or %NULL on error. **/ GIcon * g_file_icon_new (GFile *file) @@ -174,7 +174,7 @@ g_file_icon_new (GFile *file) * * Gets the #GFile associated with the given @icon. * - * Returns: a #GFile, or %NULL. + * Returns: (transfer none): a #GFile, or %NULL. **/ GFile * g_file_icon_get_file (GFileIcon *icon) diff --git a/gio/gfileinfo.c b/gio/gfileinfo.c index 439024d1f..073937bea 100644 --- a/gio/gfileinfo.c +++ b/gio/gfileinfo.c @@ -407,7 +407,7 @@ g_file_info_copy_into (GFileInfo *src_info, * * Duplicates a file info structure. * - * Returns: a duplicate #GFileInfo of @other. + * Returns: (transfer full): a duplicate #GFileInfo of @other. **/ GFileInfo * g_file_info_dup (GFileInfo *other) @@ -921,7 +921,7 @@ g_file_info_get_attribute_byte_string (GFileInfo *info, * Gets the value of a stringv attribute. If the attribute does * not contain a stringv, %NULL will be returned. * - * Returns: the contents of the @attribute value as a stringv, or + * Returns: (transfer none): the contents of the @attribute value as a stringv, or * %NULL otherwise. Do not free. * * Since: 2.22 diff --git a/gio/gfileinputstream.c b/gio/gfileinputstream.c index a710dfe94..771e8ef7c 100644 --- a/gio/gfileinputstream.c +++ b/gio/gfileinputstream.c @@ -122,7 +122,7 @@ g_file_input_stream_init (GFileInputStream *stream) * stream is blocked, the stream will set the pending flag internally, and * any other operations on the stream will fail with %G_IO_ERROR_PENDING. * - * Returns: a #GFileInfo, or %NULL on error. + * Returns: (transfer full): a #GFileInfo, or %NULL on error. **/ GFileInfo * g_file_input_stream_query_info (GFileInputStream *stream, @@ -240,7 +240,7 @@ g_file_input_stream_query_info_async (GFileInputStream *stream, * * Finishes an asynchronous info query operation. * - * Returns: #GFileInfo. + * Returns: (transfer full): #GFileInfo. **/ GFileInfo * g_file_input_stream_query_info_finish (GFileInputStream *stream, diff --git a/gio/gfileiostream.c b/gio/gfileiostream.c index 258dc053e..3af27fda2 100644 --- a/gio/gfileiostream.c +++ b/gio/gfileiostream.c @@ -136,7 +136,7 @@ g_file_io_stream_init (GFileIOStream *stream) * was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will * be returned. * - * Returns: a #GFileInfo for the @stream, or %NULL on error. + * Returns: (transfer full): a #GFileInfo for the @stream, or %NULL on error. * * Since: 2.22 **/ @@ -252,7 +252,7 @@ g_file_io_stream_query_info_async (GFileIOStream *stream, * Finalizes the asynchronous query started * by g_file_io_stream_query_info_async(). * - * Returns: A #GFileInfo for the finished query. + * Returns: (transfer full): A #GFileInfo for the finished query. * * Since: 2.22 **/ diff --git a/gio/gfileoutputstream.c b/gio/gfileoutputstream.c index 347b42d86..b3e16ecf2 100644 --- a/gio/gfileoutputstream.c +++ b/gio/gfileoutputstream.c @@ -137,7 +137,7 @@ g_file_output_stream_init (GFileOutputStream *stream) * was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will * be returned. * - * Returns: a #GFileInfo for the @stream, or %NULL on error. + * Returns: (transfer full): a #GFileInfo for the @stream, or %NULL on error. **/ GFileInfo * g_file_output_stream_query_info (GFileOutputStream *stream, @@ -250,7 +250,7 @@ g_file_output_stream_query_info_async (GFileOutputStream *stream, * Finalizes the asynchronous query started * by g_file_output_stream_query_info_async(). * - * Returns: A #GFileInfo for the finished query. + * Returns: (transfer full): A #GFileInfo for the finished query. **/ GFileInfo * g_file_output_stream_query_info_finish (GFileOutputStream *stream, diff --git a/gio/gicon.c b/gio/gicon.c index d821f27e8..115a3f5ff 100644 --- a/gio/gicon.c +++ b/gio/gicon.c @@ -75,7 +75,8 @@ g_icon_default_init (GIconInterface *iface) * @icon: #gconstpointer to an icon object. * * Gets a hash for an icon. - * + * + * Virtual: hash * Returns: a #guint containing a hash for the @icon, suitable for * use in a #GHashTable or similar data structure. **/ @@ -198,6 +199,7 @@ g_icon_to_string_tokenized (GIcon *icon, GString *s) * </para></listitem> * </itemizedlist> * + * Virtual: to_tokens * Returns: An allocated NUL-terminated UTF8 string or %NULL if @icon can't * be serialized. Use g_free() to free. * diff --git a/gio/ginetsocketaddress.c b/gio/ginetsocketaddress.c index 5f6b291f1..3f0935b58 100644 --- a/gio/ginetsocketaddress.c +++ b/gio/ginetsocketaddress.c @@ -289,7 +289,7 @@ g_inet_socket_address_new (GInetAddress *address, * * Gets @address's #GInetAddress. * - * Returns: the #GInetAddress for @address, which must be + * Returns: (transfer full): the #GInetAddress for @address, which must be * g_object_ref()'d if it will be stored * * Since: 2.22 diff --git a/gio/ginitable.c b/gio/ginitable.c index de59e206f..0fdbe767c 100644 --- a/gio/ginitable.c +++ b/gio/ginitable.c @@ -120,7 +120,7 @@ g_initable_init (GInitable *initable, * similar to g_object_new() but also initializes the object * and returns %NULL, setting an error on failure. * - * Return value: a newly allocated #GObject, or %NULL on error + * Return value: (transfer full): a newly allocated #GObject, or %NULL on error * * Since: 2.22 */ @@ -156,7 +156,7 @@ g_initable_new (GType object_type, * similar to g_object_newv() but also initializes the object * and returns %NULL, setting an error on failure. * - * Return value: a newly allocated #GObject, or %NULL on error + * Return value: (transfer full): a newly allocated #GObject, or %NULL on error * * Since: 2.22 */ @@ -196,7 +196,7 @@ g_initable_newv (GType object_type, * similar to g_object_new_valist() but also initializes the object * and returns %NULL, setting an error on failure. * - * Return value: a newly allocated #GObject, or %NULL on error + * Return value: (transfer full): a newly allocated #GObject, or %NULL on error * * Since: 2.22 */ diff --git a/gio/giomodule.c b/gio/giomodule.c index 61c3659e1..2c221e4e0 100644 --- a/gio/giomodule.c +++ b/gio/giomodule.c @@ -764,7 +764,7 @@ g_io_extension_point_get_extensions (GIOExtensionPoint *extension_point) * * Finds a #GIOExtension for an extension point by name. * - * Returns: the #GIOExtension for @extension_point that has the + * Returns: (transfer none): the #GIOExtension for @extension_point that has the * given name, or %NULL if there is no extension with that name */ GIOExtension * @@ -872,7 +872,7 @@ g_io_extension_point_implement (const char *extension_point_name, * Gets a reference to the class for the type that is * associated with @extension. * - * Returns: the #GTypeClass for the type of @extension + * Returns: (transfer full): the #GTypeClass for the type of @extension */ GTypeClass * g_io_extension_ref_class (GIOExtension *extension) diff --git a/gio/giomodule.h b/gio/giomodule.h index 035059ac9..89619c879 100644 --- a/gio/giomodule.h +++ b/gio/giomodule.h @@ -119,7 +119,7 @@ void g_io_module_unload (GIOModule *module); * run gio-querymodules in order to build the cache files required for * lazy loading. * - * Returns: A %NULL-terminated array of strings, listing the supported + * Returns: (transfer full): A %NULL-terminated array of strings, listing the supported * extension points of the module. The array must be suitable for * freeing with g_strfreev(). * diff --git a/gio/gkeyfilesettingsbackend.c b/gio/gkeyfilesettingsbackend.c index f681ba94a..f61bb8b7c 100644 --- a/gio/gkeyfilesettingsbackend.c +++ b/gio/gkeyfilesettingsbackend.c @@ -571,7 +571,7 @@ dir_changed (GFileMonitor *monitor, * @root_path: the path under which all settings keys appear * @root_group: (allow-none): the group name corresponding to * @root_path, or %NULL - * @returns: a keyfile-backed #GSettingsBackend + * @returns: (transfer full): a keyfile-backed #GSettingsBackend * * Creates a keyfile-backed #GSettingsBackend. * diff --git a/gio/gloadableicon.c b/gio/gloadableicon.c index 8d21dba96..2e53ce3ef 100644 --- a/gio/gloadableicon.c +++ b/gio/gloadableicon.c @@ -70,7 +70,7 @@ g_loadable_icon_default_init (GLoadableIconIface *iface) * Loads a loadable icon. For the asynchronous version of this function, * see g_loadable_icon_load_async(). * - * Returns: a #GInputStream to read the icon from. + * Returns: (transfer full): a #GInputStream to read the icon from. **/ GInputStream * g_loadable_icon_load (GLoadableIcon *icon, @@ -126,7 +126,7 @@ g_loadable_icon_load_async (GLoadableIcon *icon, * * Finishes an asynchronous icon load started in g_loadable_icon_load_async(). * - * Returns: a #GInputStream to read the icon from. + * Returns: (transfer full): a #GInputStream to read the icon from. **/ GInputStream * g_loadable_icon_load_finish (GLoadableIcon *icon, diff --git a/gio/gmemoryoutputstream.c b/gio/gmemoryoutputstream.c index 3b7ec2ce7..3291be4ed 100644 --- a/gio/gmemoryoutputstream.c +++ b/gio/gmemoryoutputstream.c @@ -376,7 +376,7 @@ g_memory_output_stream_new (gpointer data, } /** - * g_memory_output_stream_get_data: + * g_memory_output_stream_get_data: (skip) * @ostream: a #GMemoryOutputStream * * Gets any loaded data from the @ostream. diff --git a/gio/gmount.c b/gio/gmount.c index 685d86251..9acbf27ae 100644 --- a/gio/gmount.c +++ b/gio/gmount.c @@ -146,7 +146,7 @@ g_mount_get_root (GMount *mount) * @mount is a path that reflects the main entry point for the user (e.g. * the home directory, or the root of the volume). * - * Returns: a #GFile. + * Returns: (transfer full): a #GFile. * The returned object should be unreffed with * g_object_unref() when no longer needed. **/ @@ -800,7 +800,7 @@ g_mount_guess_content_type (GMount *mount, * %G_IO_ERROR_NOT_SUPPORTED if the mount does not support content * guessing. * - * Returns: a %NULL-terminated array of content types or %NULL on error. + * Returns: (transfer full) (element-type utf8): a %NULL-terminated array of content types or %NULL on error. * Caller should free this array with g_strfreev() when done with it. * * Since: 2.18 @@ -844,7 +844,7 @@ g_mount_guess_content_type_finish (GMount *mount, * This is an synchronous operation and as such may block doing IO; * see g_mount_guess_content_type() for the asynchronous version. * - * Returns: a %NULL-terminated array of content types or %NULL on error. + * Returns: (transfer full) (element-type utf8): a %NULL-terminated array of content types or %NULL on error. * Caller should free this array with g_strfreev() when done with it. * * Since: 2.18 diff --git a/gio/gnetworkaddress.c b/gio/gnetworkaddress.c index 11bda8ca8..ad7a87b07 100644 --- a/gio/gnetworkaddress.c +++ b/gio/gnetworkaddress.c @@ -251,7 +251,7 @@ g_network_address_set_addresses (GNetworkAddress *addr, * Creates a new #GSocketConnectable for connecting to the given * @hostname and @port. * - * Return value: the new #GNetworkAddress + * Return value: (transfer full): the new #GNetworkAddress * * Since: 2.22 */ @@ -275,7 +275,7 @@ g_network_address_new (const gchar *hostname, * @hostname and @port. May fail and return %NULL in case * parsing @host_and_port fails. * - * @host_and_port may be in any of a number of recognised formats: an IPv6 + * @host_and_port may be in any of a number of recognised formats; an IPv6 * address, an IPv4 address, or a domain name (in which case a DNS * lookup is performed). Quoting with [] is supported for all address * types. A port override may be specified in the usual way with a @@ -289,7 +289,7 @@ g_network_address_new (const gchar *hostname, * (allowing them to give the hostname, and a port overide if necessary) * and @default_port is expected to be provided by the application. * - * Return value: the new #GNetworkAddress, or %NULL on error + * Return value: (transfer full): the new #GNetworkAddress, or %NULL on error * * Since: 2.22 */ @@ -680,7 +680,7 @@ _g_uri_from_authority (const gchar *protocol, * g_network_address_parse_host() allows #GSocketClient to determine * when to use application-specific proxy protocols. * - * Return value: the new #GNetworkAddress, or %NULL on error + * Return value: (transfer full): the new #GNetworkAddress, or %NULL on error * * Since: 2.26 */ diff --git a/gio/gnetworkservice.c b/gio/gnetworkservice.c index b1d934d5f..cfecccaad 100644 --- a/gio/gnetworkservice.c +++ b/gio/gnetworkservice.c @@ -245,7 +245,7 @@ g_network_service_get_property (GObject *object, * @protocol, and @domain. This will initially be unresolved; use the * #GSocketConnectable interface to resolve it. * - * Return value: a new #GNetworkService + * Return value: (transfer full): a new #GNetworkService * * Since: 2.22 */ diff --git a/gio/goutputstream.c b/gio/goutputstream.c index df0807c0c..ff3486cfb 100644 --- a/gio/goutputstream.c +++ b/gio/goutputstream.c @@ -148,7 +148,7 @@ g_output_stream_init (GOutputStream *stream) /** * g_output_stream_write: * @stream: a #GOutputStream. - * @buffer: (array length=count) (element-type uint8): the buffer containing the data to write. + * @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 * @error: location to store the error occuring, or %NULL to ignore @@ -227,7 +227,7 @@ g_output_stream_write (GOutputStream *stream, /** * g_output_stream_write_all: * @stream: a #GOutputStream. - * @buffer: (array length=count) (element-type uint8): the buffer containing the data to write. + * @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 * written to the stream @@ -651,7 +651,7 @@ async_ready_close_flushed_callback_wrapper (GObject *source_object, /** * g_output_stream_write_async: * @stream: A #GOutputStream. - * @buffer: (array length=count) (element-type uint8): the buffer containing the data to write. + * @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. diff --git a/gio/gproxy.c b/gio/gproxy.c index 65c42add2..b40e23caa 100644 --- a/gio/gproxy.c +++ b/gio/gproxy.c @@ -92,7 +92,7 @@ g_proxy_get_default_for_protocol (const gchar *protocol) * does the necessary handshake to connect to @proxy_address, and if * required, wraps the #GIOStream to handle proxy payload. * - * Return value: a #GIOStream that will replace @connection. This might + * Return value: (transfer full): a #GIOStream that will replace @connection. This might * be the same as @connection, in which case a reference * will be added. * @@ -161,7 +161,7 @@ g_proxy_connect_async (GProxy *proxy, * * See g_proxy_connect(). * - * Return value: a #GIOStream. + * Return value: (transfer full): a #GIOStream. * * Since: 2.26 */ diff --git a/gio/gproxyresolver.c b/gio/gproxyresolver.c index 62f41cfec..f6b60015d 100644 --- a/gio/gproxyresolver.c +++ b/gio/gproxyresolver.c @@ -101,7 +101,7 @@ get_default_proxy_resolver (gpointer arg) * * Gets the default #GProxyResolver for the system. * - * Return value: the default #GProxyResolver. + * Return value: (transfer none): the default #GProxyResolver. * * Since: 2.26 */ @@ -160,7 +160,7 @@ g_proxy_resolver_is_supported (GProxyResolver *resolver) * Direct connection should not be attempted unless it is part of the * returned array of proxies. * - * Return value: A NULL-terminated array of proxy URIs. Must be freed with + * Return value: (transfer full) (element-type utf8): A NULL-terminated array of proxy URIs. Must be freed with * g_strfreev(). * * Since: 2.26 @@ -221,7 +221,7 @@ g_proxy_resolver_lookup_async (GProxyResolver *resolver, * g_proxy_resolver_lookup_async() is complete. See * g_proxy_resolver_lookup() for more details. * - * Return value: A NULL-terminated array of proxy URIs. Must be freed with + * Return value: (transfer full) (element-type utf8): A NULL-terminated array of proxy URIs. Must be freed with * g_strfreev(). * * Since: 2.26 diff --git a/gio/gresolver.c b/gio/gresolver.c index 5d86323d5..01c6db0e9 100644 --- a/gio/gresolver.c +++ b/gio/gresolver.c @@ -144,7 +144,7 @@ static GResolver *default_resolver; * many threads/processes, etc it should allocate for concurrent DNS * resolutions. * - * Return value: the default #GResolver. + * Return value: (transfer full): the default #GResolver. * * Since: 2.22 */ diff --git a/gio/gseekable.c b/gio/gseekable.c index 78b7108c8..976243d40 100644 --- a/gio/gseekable.c +++ b/gio/gseekable.c @@ -154,7 +154,8 @@ g_seekable_can_truncate (GSeekable *seekable) * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an * operation was partially finished when the operation was cancelled the * partial result will be returned, without an error. - * + * + * Virtual: truncate_fn * Returns: %TRUE if successful. If an error * has occurred, this function will return %FALSE and set @error * appropriately if present. diff --git a/gio/gsettings.c b/gio/gsettings.c index 7fc38e27e..81fdd8df5 100644 --- a/gio/gsettings.c +++ b/gio/gsettings.c @@ -1525,7 +1525,7 @@ g_settings_set (GSettings *settings, * @mapping: the function to map the value in the settings database to * the value used by the application * @user_data: user data for @mapping - * @returns: the result, which may be %NULL + * @returns: (transfer full): the result, which may be %NULL * * Gets the value that is stored at @key in @settings, subject to * application-level validation/mapping. @@ -2050,7 +2050,7 @@ g_settings_is_writable (GSettings *settings, * g_settings_get_child: * @settings: a #GSettings object * @name: the name of the 'child' schema - * @returns: a 'child' settings object + * @returns: (transfer full): a 'child' settings object * * Creates a 'child' settings object which has a base path of * <replaceable>base-path</replaceable>/@name", where @@ -2093,7 +2093,7 @@ g_settings_get_child (GSettings *settings, /** * g_settings_list_keys: * @settings: a #GSettings object - * @returns: a list of the keys on @settings + * @returns: (transfer full) (element-type utf8): a list of the keys on @settings * * Introspects the list of keys on @settings. * @@ -2129,7 +2129,7 @@ g_settings_list_keys (GSettings *settings) /** * g_settings_list_children: * @settings: a #GSettings object - * @returns: a list of the children on @settings + * @returns: (transfer full) (element-type utf8): a list of the children on @settings * * Gets the list of children on @settings. * diff --git a/gio/gsettingsbackend.c b/gio/gsettingsbackend.c index 8485cd329..bde0336d5 100644 --- a/gio/gsettingsbackend.c +++ b/gio/gsettingsbackend.c @@ -386,7 +386,7 @@ g_settings_backend_dispatch_signal (GSettingsBackend *backend, * implementations should call this if a key has possibly changed its * value. * - * @key must be a valid key (ie: starting with a slash, not containing + * @key must be a valid key (ie starting with a slash, not containing * '//', and not ending with a slash). * * The implementation must call this function during any call to @@ -432,7 +432,7 @@ g_settings_backend_changed (GSettingsBackend *backend, * implementations should call this if keys have possibly changed their * values. * - * @path must be a valid path (ie: starting and ending with a slash and + * @path must be a valid path (ie starting and ending with a slash and * not containing '//'). Each string in @items must form a valid key * name when @path is prefixed to it (ie: each item must not start or * end with '/' and must not contain '//'). @@ -483,7 +483,7 @@ g_settings_backend_keys_changed (GSettingsBackend *backend, * Backend implementations should call this if an entire path of keys * have possibly changed their values. * - * @path must be a valid path (ie: starting and ending with a slash and + * @path must be a valid path (ie starting and ending with a slash and * not containing '//'). * * The meaning of this signal is that any of the key which has a name diff --git a/gio/gsettingsschema.c b/gio/gsettingsschema.c index 6d8d77a9a..053b94e72 100644 --- a/gio/gsettingsschema.c +++ b/gio/gsettingsschema.c @@ -97,7 +97,7 @@ add_item (gpointer key, * g_settings_list_schemas: * @returns: a list of the schemas installed on the system * - * Returns a list of GSettings schemas that are available. The list + * Returns: (element-type utf8) (transfer none): a list of GSettings schemas that are available. The list * must not be modified or freed. **/ const gchar * const * diff --git a/gio/gsimpleasyncresult.c b/gio/gsimpleasyncresult.c index b76a54e7d..c9563f4e5 100644 --- a/gio/gsimpleasyncresult.c +++ b/gio/gsimpleasyncresult.c @@ -439,7 +439,7 @@ g_simple_async_result_set_handle_cancellation (GSimpleAsyncResult *simple, } /** - * g_simple_async_result_get_source_tag: + * g_simple_async_result_get_source_tag: (skip) * @simple: a #GSimpleAsyncResult. * * Gets the source tag for the #GSimpleAsyncResult. @@ -500,7 +500,7 @@ g_simple_async_result_set_op_res_gpointer (GSimpleAsyncResult *simple, } /** - * g_simple_async_result_get_op_res_gpointer: + * g_simple_async_result_get_op_res_gpointer: (skip): * @simple: a #GSimpleAsyncResult. * * Gets a pointer result as returned by the asynchronous function. diff --git a/gio/gsocket.c b/gio/gsocket.c index ba7be0184..dbedc3752 100644 --- a/gio/gsocket.c +++ b/gio/gsocket.c @@ -1203,7 +1203,7 @@ g_socket_get_fd (GSocket *socket) * useful if the socket has been bound to a local address, * either explicitly or implicitly when connecting. * - * Returns: a #GSocketAddress or %NULL on error. + * Returns: (transfer full): a #GSocketAddress or %NULL on error. * Free the returned object with g_object_unref(). * * Since: 2.22 @@ -1236,7 +1236,7 @@ g_socket_get_local_address (GSocket *socket, * Try to get the remove address of a connected socket. This is only * useful for connection oriented sockets that have been connected. * - * Returns: a #GSocketAddress or %NULL on error. + * Returns: (transfer full): a #GSocketAddress or %NULL on error. * Free the returned object with g_object_unref(). * * Since: 2.22 @@ -1471,7 +1471,7 @@ g_socket_speaks_ipv4 (GSocket *socket) * or return %G_IO_ERROR_WOULD_BLOCK if non-blocking I/O is enabled. * To be notified of an incoming connection, wait for the %G_IO_IN condition. * - * Returns: a new #GSocket, or %NULL on error. + * Returns: (transfer full): a new #GSocket, or %NULL on error. * Free the returned object with g_object_unref(). * * Since: 2.22 @@ -2564,7 +2564,7 @@ socket_source_new (GSocket *socket, * marked as having had a timeout, and so the next #GSocket I/O method * you call will then fail with a %G_IO_ERROR_TIMED_OUT. * - * Returns: a newly allocated %GSource, free with g_source_unref(). + * Returns: (transfer full): a newly allocated %GSource, free with g_source_unref(). * * Since: 2.22 */ @@ -3445,7 +3445,7 @@ g_socket_receive_message (GSocket *socket, * g_unix_connection_send_credentials() / * g_unix_connection_receive_credentials() functions. * - * Returns: %NULL if @error is set, otherwise a #GCredentials object + * Returns: (transfer full): %NULL if @error is set, otherwise a #GCredentials object * that must be freed with g_object_unref(). * * Since: 2.26 diff --git a/gio/gsocketaddressenumerator.c b/gio/gsocketaddressenumerator.c index f1b5a2d32..7ad1ccc1a 100644 --- a/gio/gsocketaddressenumerator.c +++ b/gio/gsocketaddressenumerator.c @@ -67,7 +67,7 @@ g_socket_address_enumerator_class_init (GSocketAddressEnumeratorClass *enumerato * internal errors (other than @cancellable being triggered) will be * ignored. * - * Return value: a #GSocketAddress (owned by the caller), or %NULL on + * Return value: (transfer full): a #GSocketAddress (owned by the caller), or %NULL on * error (in which case *@error will be set) or if there are no * more addresses. */ @@ -168,7 +168,7 @@ g_socket_address_enumerator_real_next_finish (GSocketAddressEnumerator *enumera * g_socket_address_enumerator_next() for more information about * error handling. * - * Return value: a #GSocketAddress (owned by the caller), or %NULL on + * Return value: (transfer full): a #GSocketAddress (owned by the caller), or %NULL on * error (in which case *@error will be set) or if there are no * more addresses. */ diff --git a/gio/gsocketclient.c b/gio/gsocketclient.c index dd2c0d3fd..7064fc830 100644 --- a/gio/gsocketclient.c +++ b/gio/gsocketclient.c @@ -621,7 +621,7 @@ g_socket_client_class_init (GSocketClientClass *class) * If a local address is specified with g_socket_client_set_local_address() the * socket will be bound to this address before connecting. * - * Returns: a #GSocketConnection on success, %NULL on error. + * Returns: (transfer full): a #GSocketConnection on success, %NULL on error. * * Since: 2.22 */ @@ -772,7 +772,7 @@ g_socket_client_connect (GSocketClient *client, * * Attempts to create a TCP connection to the named host. * - * @host_and_port may be in any of a number of recognised formats: an IPv6 + * @host_and_port may be in any of a number of recognised formats; an IPv6 * address, an IPv4 address, or a domain name (in which case a DNS * lookup is performed). Quoting with [] is supported for all address * types. A port override may be specified in the usual way with a @@ -799,7 +799,7 @@ g_socket_client_connect (GSocketClient *client, * connectable) %NULL is returned and @error (if non-%NULL) is set * accordingly. * - Returns: a #GSocketConnection on success, %NULL on error. + * Returns: (transfer full): a #GSocketConnection on success, %NULL on error. * * Since: 2.22 */ @@ -831,7 +831,7 @@ g_socket_client_connect_to_host (GSocketClient *client, * @service: the name of the service to connect to * @cancellable: a #GCancellable, or %NULL * @error: a pointer to a #GError, or %NULL - * @returns: a #GSocketConnection if successful, or %NULL on error + * @returns: (transfer full): a #GSocketConnection if successful, or %NULL on error * * Attempts to create a TCP connection to a service. * @@ -894,7 +894,7 @@ g_socket_client_connect_to_service (GSocketClient *client, * connectable) %NULL is returned and @error (if non-%NULL) is set * accordingly. * - * Returns: a #GSocketConnection on success, %NULL on error. + * Returns: (transfer full): a #GSocketConnection on success, %NULL on error. * * Since: 2.26 */ @@ -1379,7 +1379,7 @@ g_socket_client_connect_to_uri_async (GSocketClient *client, * * Finishes an async connect operation. See g_socket_client_connect_async() * - * Returns: a #GSocketConnection on success, %NULL on error. + * Returns: (transfer full): a #GSocketConnection on success, %NULL on error. * * Since: 2.22 */ @@ -1405,7 +1405,7 @@ g_socket_client_connect_finish (GSocketClient *client, * * Finishes an async connect operation. See g_socket_client_connect_to_host_async() * - * Returns: a #GSocketConnection on success, %NULL on error. + * Returns: (transfer full): a #GSocketConnection on success, %NULL on error. * * Since: 2.22 */ @@ -1426,7 +1426,7 @@ g_socket_client_connect_to_host_finish (GSocketClient *client, * * Finishes an async connect operation. See g_socket_client_connect_to_service_async() * - * Returns: a #GSocketConnection on success, %NULL on error. + * Returns: (transfer full): a #GSocketConnection on success, %NULL on error. * * Since: 2.22 */ @@ -1447,7 +1447,7 @@ g_socket_client_connect_to_service_finish (GSocketClient *client, * * Finishes an async connect operation. See g_socket_client_connect_to_uri_async() * - * Returns: a #GSocketConnection on success, %NULL on error. + * Returns: (transfer full): a #GSocketConnection on success, %NULL on error. * * Since: 2.26 */ diff --git a/gio/gsocketconnectable.c b/gio/gsocketconnectable.c index aab171cc0..3bad099b8 100644 --- a/gio/gsocketconnectable.c +++ b/gio/gsocketconnectable.c @@ -105,7 +105,7 @@ g_socket_connectable_default_init (GSocketConnectableInterface *iface) * * Creates a #GSocketAddressEnumerator for @connectable. * - * Return value: a new #GSocketAddressEnumerator. + * Return value: (transfer full): a new #GSocketAddressEnumerator. * * Since: 2.22 */ @@ -133,7 +133,7 @@ g_socket_connectable_enumerate (GSocketConnectable *connectable) * g_socket_connectable_proxy_enumerate(), this will fall back to * calling g_socket_connectable_enumerate(). * - * Return value: a new #GSocketAddressEnumerator. + * Return value: (transfer full): a new #GSocketAddressEnumerator. * * Since: 2.26 */ diff --git a/gio/gsocketconnection.c b/gio/gsocketconnection.c index c68465d95..e67237fc5 100644 --- a/gio/gsocketconnection.c +++ b/gio/gsocketconnection.c @@ -141,7 +141,7 @@ g_socket_connection_get_socket (GSocketConnection *connection) * * Try to get the local address of a socket connection. * - * Returns: a #GSocketAddress or %NULL on error. + * Returns: (transfer full): a #GSocketAddress or %NULL on error. * Free the returned object with g_object_unref(). * * Since: 2.22 @@ -160,7 +160,7 @@ g_socket_connection_get_local_address (GSocketConnection *connection, * * Try to get the remote address of a socket connection. * - * Returns: a #GSocketAddress or %NULL on error. + * Returns: (transfer full): a #GSocketAddress or %NULL on error. * Free the returned object with g_object_unref(). * * Since: 2.22 @@ -504,7 +504,7 @@ g_socket_connection_factory_lookup_type (GSocketFamily family, * Creates a #GSocketConnection subclass of the right type for * @socket. * - * Returns: a #GSocketConnection + * Returns: (transfer full): a #GSocketConnection * * Since: 2.22 */ diff --git a/gio/gsocketcontrolmessage.c b/gio/gsocketcontrolmessage.c index a1879bb9e..cce825867 100644 --- a/gio/gsocketcontrolmessage.c +++ b/gio/gsocketcontrolmessage.c @@ -163,7 +163,7 @@ g_socket_control_message_class_init (GSocketControlMessageClass *class) * If there is no implementation for this kind of control message, %NULL * will be returned. * - * Returns: the deserialized message or %NULL + * Returns: (transfer full): the deserialized message or %NULL * * Since: 2.22 */ diff --git a/gio/gsocketlistener.c b/gio/gsocketlistener.c index 0fba2e78c..8bb574893 100644 --- a/gio/gsocketlistener.c +++ b/gio/gsocketlistener.c @@ -581,7 +581,7 @@ accept_callback (GSocket *socket, * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * Returns: a #GSocket on success, %NULL on error. + * Returns: (transfer full): a #GSocket on success, %NULL on error. * * Since: 2.22 */ @@ -655,7 +655,7 @@ g_socket_listener_accept_socket (GSocketListener *listener, * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * Returns: a #GSocketConnection on success, %NULL on error. + * Returns: (transfer full): a #GSocketConnection on success, %NULL on error. * * Since: 2.22 */ @@ -777,7 +777,7 @@ g_socket_listener_accept_socket_async (GSocketListener *listener, * * Finishes an async accept operation. See g_socket_listener_accept_socket_async() * - * Returns: a #GSocket on success, %NULL on error. + * Returns: (transfer full): a #GSocket on success, %NULL on error. * * Since: 2.22 */ @@ -844,7 +844,7 @@ g_socket_listener_accept_async (GSocketListener *listener, * * Finishes an async accept operation. See g_socket_listener_accept_async() * - * Returns: a #GSocketConnection on success, %NULL on error. + * Returns: (transfer full): a #GSocketConnection on success, %NULL on error. * * Since: 2.22 */ diff --git a/gio/gsrvtarget.c b/gio/gsrvtarget.c index 5bcf111de..21c057504 100644 --- a/gio/gsrvtarget.c +++ b/gio/gsrvtarget.c @@ -227,7 +227,7 @@ compare_target (gconstpointer a, gconstpointer b) * * Sorts @targets in place according to the algorithm in RFC 2782. * - * Return value: the head of the sorted list. + * Return value: (transfer full): the head of the sorted list. * * Since: 2.22 */ diff --git a/gio/gthemedicon.c b/gio/gthemedicon.c index 1380e83fb..da598d2b8 100644 --- a/gio/gthemedicon.c +++ b/gio/gthemedicon.c @@ -263,7 +263,7 @@ g_themed_icon_init (GThemedIcon *themed) * * Creates a new themed icon for @iconname. * - * Returns: a new #GThemedIcon. + * Returns: (transfer full): a new #GThemedIcon. **/ GIcon * g_themed_icon_new (const char *iconname) @@ -281,7 +281,7 @@ g_themed_icon_new (const char *iconname) * * Creates a new themed icon for @iconnames. * - * Returns: a new #GThemedIcon + * Returns: (transfer full): a new #GThemedIcon **/ GIcon * g_themed_icon_new_from_names (char **iconnames, @@ -333,7 +333,7 @@ g_themed_icon_new_from_names (char **iconnames, * icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio"); * ]| * - * Returns: a new #GThemedIcon. + * Returns: (transfer full): a new #GThemedIcon. */ GIcon * g_themed_icon_new_with_default_fallbacks (const char *iconname) @@ -350,7 +350,7 @@ g_themed_icon_new_with_default_fallbacks (const char *iconname) * * Gets the names of icons from within @icon. * - * Returns: a list of icon names. + * Returns: (transfer full): a list of icon names. */ const char * const * g_themed_icon_get_names (GThemedIcon *icon) diff --git a/gio/gunionvolumemonitor.c b/gio/gunionvolumemonitor.c index 0fb971453..5320b0452 100644 --- a/gio/gunionvolumemonitor.c +++ b/gio/gunionvolumemonitor.c @@ -555,7 +555,7 @@ g_union_volume_monitor_new (void) * * Gets the volume monitor used by gio. * - * Returns: a reference to the #GVolumeMonitor used by gio. Call + * Returns: (transfer full): a reference to the #GVolumeMonitor used by gio. Call * g_object_unref() when done with it. **/ GVolumeMonitor * diff --git a/gio/gunixconnection.c b/gio/gunixconnection.c index cf0b6f42b..82510f5c9 100644 --- a/gio/gunixconnection.c +++ b/gio/gunixconnection.c @@ -386,7 +386,7 @@ g_unix_connection_send_credentials (GUnixConnection *connection, * Other ways to exchange credentials with a foreign peer includes the * #GUnixCredentialsMessage type and g_socket_get_credentials() function. * - * Returns: Received credentials on success (free with + * Returns: (transfer full): Received credentials on success (free with * g_object_unref()), %NULL if @error is set. * * Since: 2.26 diff --git a/gio/gunixcredentialsmessage.c b/gio/gunixcredentialsmessage.c index 82224ab6b..ece892cfc 100644 --- a/gio/gunixcredentialsmessage.c +++ b/gio/gunixcredentialsmessage.c @@ -380,7 +380,7 @@ g_unix_credentials_message_new_with_credentials (GCredentials *credentials) * * Gets the credentials stored in @message. * - * Returns: A #GCredentials instance. Do not free, it is owned by @message. + * Returns: (transfer none): A #GCredentials instance. Do not free, it is owned by @message. * * Since: 2.26 */ diff --git a/gio/gunixfdmessage.c b/gio/gunixfdmessage.c index 665f0584a..7dc0f8bbb 100644 --- a/gio/gunixfdmessage.c +++ b/gio/gunixfdmessage.c @@ -157,7 +157,7 @@ g_unix_fd_message_set_property (GObject *object, guint prop_id, * return a reference to the caller, but the returned list is valid for * the lifetime of @message. * - * Returns: the #GUnixFDList from @message + * Returns: (transfer none): the #GUnixFDList from @message * * Since: 2.24 **/ diff --git a/gio/gunixmounts.c b/gio/gunixmounts.c index e509421ad..b58ab6292 100644 --- a/gio/gunixmounts.c +++ b/gio/gunixmounts.c @@ -1103,7 +1103,7 @@ g_unix_mounts_get (guint64 *time_read) * is set, it will be filled with a unix timestamp for checking * if the mounts have changed since with g_unix_mounts_changed_since(). * - * Returns: a #GUnixMount. + * Returns: (transfer full): a #GUnixMount. **/ GUnixMountEntry * g_unix_mount_at (const char *mount_path, @@ -1856,7 +1856,7 @@ g_unix_mount_guess_name (GUnixMountEntry *mount_entry) * * Guesses the icon of a Unix mount. * - * Returns: a #GIcon + * Returns: (transfer full): a #GIcon */ GIcon * g_unix_mount_guess_icon (GUnixMountEntry *mount_entry) @@ -1893,7 +1893,7 @@ g_unix_mount_point_guess_name (GUnixMountPoint *mount_point) * * Guesses the icon of a Unix mount point. * - * Returns: a #GIcon + * Returns: (transfer full): a #GIcon */ GIcon * g_unix_mount_point_guess_icon (GUnixMountPoint *mount_point) diff --git a/gio/gvfs.c b/gio/gvfs.c index d439c161e..697c69bb5 100644 --- a/gio/gvfs.c +++ b/gio/gvfs.c @@ -77,7 +77,7 @@ g_vfs_is_active (GVfs *vfs) * * Gets a #GFile for @path. * - * Returns: a #GFile. + * Returns: (transfer full): a #GFile. * Free the returned object with g_object_unref(). **/ GFile * @@ -105,7 +105,7 @@ g_vfs_get_file_for_path (GVfs *vfs, * might not support any I/O operation if the URI * is malformed or if the URI scheme is not supported. * - * Returns: a #GFile. + * Returns: (transfer full): a #GFile. * Free the returned object with g_object_unref(). **/ GFile * @@ -128,7 +128,7 @@ g_vfs_get_file_for_uri (GVfs *vfs, * * Gets a list of URI schemes supported by @vfs. * - * Returns: a %NULL-terminated array of strings. + * Returns: (transfer none): a %NULL-terminated array of strings. * The returned array belongs to GIO and must * not be freed or modified. **/ @@ -153,7 +153,7 @@ g_vfs_get_supported_uri_schemes (GVfs *vfs) * not support any I/O operations if the @parse_name cannot * be parsed by the #GVfs module. * - * Returns: a #GFile for the given @parse_name. + * Returns: (transfer full): a #GFile for the given @parse_name. * Free the returned object with g_object_unref(). **/ GFile * @@ -222,7 +222,7 @@ get_default_vfs (gpointer arg) * * Gets the default #GVfs for the system. * - * Returns: a #GVfs. + * Returns: (transfer none): a #GVfs. **/ GVfs * g_vfs_get_default (void) @@ -237,7 +237,7 @@ g_vfs_get_default (void) * * Gets the local #GVfs for the system. * - * Returns: a #GVfs. + * Returns: (transfer none): a #GVfs. **/ GVfs * g_vfs_get_local (void) diff --git a/gio/gvolume.c b/gio/gvolume.c index 33e8aea74..df1b78d31 100644 --- a/gio/gvolume.c +++ b/gio/gvolume.c @@ -308,6 +308,8 @@ g_volume_should_automount (GVolume *volume) * Mounts a volume. This is an asynchronous operation, and is * finished by calling g_volume_mount_finish() with the @volume * and #GAsyncResult returned in the @callback. + * + * Virtual: mount_fn **/ void g_volume_mount (GVolume *volume, diff --git a/gio/gvolumemonitor.c b/gio/gvolumemonitor.c index ee53ca26e..bb0fd3532 100644 --- a/gio/gvolumemonitor.c +++ b/gio/gvolumemonitor.c @@ -373,7 +373,7 @@ g_volume_monitor_get_volume_for_uuid (GVolumeMonitor *volume_monitor, * * Finds a #GMount object by its UUID (see g_mount_get_uuid()) * - * Returns: a #GMount or %NULL if no such mount is available. + * Returns: (transfer full): a #GMount or %NULL if no such mount is available. * Free the returned object with g_object_unref(). **/ GMount * |