[gobject-introspection] Update annotations from glib git

From: Colin Walters <walters src gnome org>
To: commits-list gnome org
Cc:
Subject: [gobject-introspection] Update annotations from glib git
Date: Wed, 11 Jan 2012 20:58:50 +0000 (UTC)
commit 526ba422f196c0287311b913fb1f05b043f7f093
Author: Colin Walters <walters verbum org>
Date:   Wed Jan 11 15:58:08 2012 -0500

    Update annotations from glib git

 gir/gio-2.0.c  |  123 +++++++++++++++++++++++++++++++++-----------------------
 gir/glib-2.0.c |   12 +++---
 2 files changed, 79 insertions(+), 56 deletions(-)
---
diff --git a/gir/gio-2.0.c b/gir/gio-2.0.c
index b750f90..802a0b3 100644
--- a/gir/gio-2.0.c
+++ b/gir/gio-2.0.c
@@ -3225,7 +3225,7 @@
  * GFileMonitor::changed:
  * @monitor: a #GFileMonitor.
  * @file: a #GFile.
- * @other_file: a #GFile or #NULL.
+ * @other_file: (allow-none): a #GFile or #NULL.
  * @event_type: a #GFileMonitorEvent.
  *
  * Emitted when @file has been changed.
@@ -4205,7 +4205,7 @@
  * GMountOperation::show-processes:
  * @op: a #GMountOperation.
  * @message: string containing a message to display to the user.
- * @processes: an array of #GPid for processes blocking the operation.
+ * @processes: (element-type GPid): an array of #GPid for processes blocking the operation.
  * @choices: an array of strings for each possible choice.
  *
  * Emitted when one or more processes are blocking an operation
@@ -6160,7 +6160,7 @@
  * GSocketService::incoming:
  * @service: the #GSocketService
  * @connection: a new #GSocketConnection object
- * @source_object: the source_object passed to g_socket_listener_add_address()
+ * @source_object: (allow-none): the source_object passed to g_socket_listener_add_address()
  *
  * The ::incoming signal is emitted when a new incoming connection
  * to @service needs to be handled. The handler must initiate the
@@ -8566,6 +8566,17 @@
 
 
 /**
+ * G_FILE_ATTRIBUTE_FILESYSTEM_USED:
+ *
+ * A key in the "filesystem" namespace for getting the number of bytes of used on the
+ * file system. Corresponding #GFileAttributeType is
+ * %G_FILE_ATTRIBUTE_TYPE_UINT64.
+ *
+ * Since: 2.32
+ */
+
+
+/**
  * G_FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW:
  *
  * A key in the "filesystem" namespace for hinting a file manager
@@ -13644,6 +13655,7 @@
  * <row><entry>%G_FILE_ATTRIBUTE_PREVIEW_ICON</entry><entry>preview::icon</entry><entry>object (#GIcon)</entry></row>
  * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_SIZE</entry><entry>filesystem::size</entry><entry>uint64</entry></row>
  * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_FREE</entry><entry>filesystem::free</entry><entry>uint64</entry></row>
+ * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_USED</entry><entry>filesystem::used</entry><entry>uint64</entry></row>
  * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_TYPE</entry><entry>filesystem::type</entry><entry>string</entry></row>
  * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_READONLY</entry><entry>filesystem::readonly</entry><entry>boolean</entry></row>
  * <row><entry>%G_FILE_ATTRIBUTE_GVFS_BACKEND</entry><entry>gvfs::backend</entry><entry>string</entry></row>
@@ -17228,7 +17240,7 @@
  *
  * For local invocation, it will be %NULL.
  *
- * Returns: the platform data, or %NULL
+ * Returns: (allow-none): the platform data, or %NULL
  * Since: 2.28
  */
 
@@ -17977,7 +17989,7 @@
 /**
  * g_buffered_input_stream_peek:
  * @stream: a #GBufferedInputStream
- * @buffer: a pointer to an allocated chunk of memory
+ * @buffer: (array length=count) (element-type guint8): a pointer to an allocated chunk of memory
  * @offset: a #gsize
  * @count: a #gsize
  *
@@ -18827,7 +18839,7 @@
  * This function is useful in the implementation of
  * g_mount_guess_content_type().
  *
- * array of zero or more content types, or %NULL. Free with g_strfreev()
+ * array of zero or more content types. Free with g_strfreev()
  *
  * Returns: (transfer full) (array zero-terminated=1): an %NULL-terminated
  * Since: 2.18
@@ -19827,7 +19839,7 @@
 
 /**
  * g_dbus_annotation_info_lookup:
- * @annotations: A %NULL-terminated array of annotations or %NULL.
+ * @annotations: (array zero-terminated=1): A %NULL-terminated array of annotations or %NULL.
  * @name: The name of the annotation to look up.
  *
  * Looks up the value of an annotation.
@@ -21734,7 +21746,7 @@
 
 /**
  * g_dbus_message_bytes_needed:
- * @blob: A blob represent a binary D-Bus message.
+ * @blob: (array length=blob_len) (element-type guint8): A blob represent a binary D-Bus message.
  * @blob_len: The length of @blob (must be at least 16).
  * @error: Return location for error or %NULL.
  *
@@ -21855,10 +21867,10 @@
  *
  * Gets an array of all header fields on @message that are set.
  *
- * %G_DBUS_MESSAGE_HEADER_FIELD_INVALID.  Each element is a
- * #guchar. Free with g_free().
+ * terminated by %G_DBUS_MESSAGE_HEADER_FIELD_INVALID.  Each element
+ * is a #guchar. Free with g_free().
  *
- * Returns: An array of header fields terminated by
+ * Returns: (array zero-terminated=1): An array of header fields
  * Since: 2.26
  */
 
@@ -22012,7 +22024,7 @@
 
 /**
  * g_dbus_message_new_from_blob:
- * @blob: A blob represent a binary D-Bus message.
+ * @blob: (array length=blob_len) (element-type guint8): A blob represent a binary D-Bus message.
  * @blob_len: The length of @blob.
  * @capabilities: A #GDBusCapabilityFlags describing what protocol features are supported.
  * @error: Return location for error or %NULL.
@@ -22347,9 +22359,10 @@
  * Serializes @message to a blob. The byte order returned by
  * g_dbus_message_get_byte_order() will be used.
  *
- * generated by @message or %NULL if @error is set. Free with g_free().
+ * valid binary D-Bus message of @out_size bytes generated by @message
+ * or %NULL if @error is set. Free with g_free().
  *
- * Returns: A pointer to a valid binary D-Bus message of @out_size bytes
+ * Returns: (array length=out_size) (transfer full): A pointer to a
  * Since: 2.26
  */
 
@@ -23791,7 +23804,7 @@
  * @address: A D-Bus address.
  * @flags: Flags from the #GDBusServerFlags enumeration.
  * @guid: A D-Bus GUID.
- * @observer: A #GDBusAuthObserver or %NULL.
+ * @observer: (allow-none): A #GDBusAuthObserver or %NULL.
  * @cancellable: A #GCancellable or %NULL.
  * @error: Return location for server or %NULL.
  *
@@ -24521,7 +24534,7 @@
  *
  * Creates a new emblemed icon for @icon with the emblem @emblem.
  *
- * Returns: (transfer full): a new #GIcon
+ * Returns: (transfer full) (type GEmblemedIcon): a new #GIcon
  * Since: 2.18
  */
 
@@ -25133,7 +25146,7 @@
  * g_file_eject_mountable_with_operation:
  * @file: input #GFile.
  * @flags: flags affecting the operation
- * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
+ * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
  * @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
@@ -25645,7 +25658,7 @@
 /**
  * g_file_has_parent:
  * @file: input #GFile
- * @parent: the parent to check for, or %NULL
+ * @parent: (allow-none): the parent to check for, or %NULL
  *
  * Checks if @file has a parent, and optionally, if it is @parent.
  *
@@ -25731,7 +25744,9 @@
  *
  * Creates a new icon for a file.
  *
- * Returns: (transfer full): a #GIcon for the given @file, or %NULL on error.
+ * @file, or %NULL on error.
+ *
+ * Returns: (transfer full) (type GFileIcon): a #GIcon for the given
  */
 
 
@@ -26251,7 +26266,7 @@
  * g_file_info_set_attribute_stringv:
  * @info: a #GFileInfo.
  * @attribute: a file attribute key
- * @attr_value: a %NULL terminated array of UTF-8 strings.
+ * @attr_value: (array) (element-type utf8): a %NULL terminated array of UTF-8 strings.
  *
  * Sets the @attribute to contain the given @attr_value,
  * if possible.
@@ -26854,8 +26869,8 @@
  * g_file_mount_enclosing_volume:
  * @location: input #GFile.
  * @flags: flags affecting the operation
- * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
- * @cancellable: optional #GCancellable object, %NULL to ignore.
+ * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid user interaction.
+ * @cancellable: (allow-none): 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
  *
@@ -26890,7 +26905,7 @@
  * g_file_mount_mountable:
  * @file: input #GFile.
  * @flags: flags affecting the operation
- * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
+ * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
  * @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
@@ -26931,7 +26946,7 @@
  * @destination: #GFile pointing to the destination location.
  * @flags: set of #GFileCopyFlags.
  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
- * @progress_callback: (scope call): #GFileProgressCallback function for updates.
+ * @progress_callback: (allow-none) (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
  *
@@ -28079,7 +28094,7 @@
  * g_file_start_mountable:
  * @file: input #GFile.
  * @flags: flags affecting the operation
- * @start_operation: a #GMountOperation, or %NULL to avoid user interaction.
+ * @start_operation: (allow-none): 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
@@ -28121,7 +28136,7 @@
  * g_file_stop_mountable:
  * @file: input #GFile.
  * @flags: flags affecting the operation
- * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
+ * @mount_operation: (allow-none): 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
@@ -28235,7 +28250,7 @@
  * g_file_unmount_mountable_with_operation:
  * @file: input #GFile.
  * @flags: flags affecting the operation
- * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
+ * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
  * @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
@@ -28379,8 +28394,8 @@
 
 /**
  * g_icon_equal:
- * @icon1: pointer to the first #GIcon.
- * @icon2: pointer to the second #GIcon.
+ * @icon1: (allow-none): pointer to the first #GIcon.
+ * @icon2: (allow-none): pointer to the second #GIcon.
  *
  * Checks if two icons are equal.
  *
@@ -28721,7 +28736,7 @@
 
 /**
  * g_inet_address_new_from_bytes:
- * @bytes: raw address data
+ * @bytes: (array) (element-type guint8): raw address data
  * @family: the address family of @bytes
  *
  * Creates a new #GInetAddress from the given @family and @bytes.
@@ -28897,7 +28912,7 @@
  * g_initable_newv:
  * @object_type: a #GType supporting #GInitable.
  * @n_parameters: the number of parameters in @parameters
- * @parameters: the parameters to use to construct the object
+ * @parameters: (array length=n_parameters): the parameters to use to construct the object
  * @cancellable: optional #GCancellable object, %NULL to ignore.
  * @error: a #GError location to store the error occurring, or %NULL to ignore.
  *
@@ -30001,7 +30016,7 @@
 /**
  * g_memory_input_stream_add_data:
  * @stream: a #GMemoryInputStream
- * @data: (array length=len) (element-type guint8): input data
+ * @data: (array length=len) (element-type guint8) (transfer full): input data
  * @len: length of the data, may be -1 if @data is a nul-terminated string
  * @destroy: (allow-none): function that is called to free @data, or %NULL
  *
@@ -30020,7 +30035,7 @@
 
 /**
  * g_memory_input_stream_new_from_data:
- * @data: (array length=len) (element-type guint8): input data
+ * @data: (array length=len) (element-type guint8) (transfer full): input data
  * @len: length of the data, may be -1 if @data is a nul-terminated string
  * @destroy: (allow-none): function that is called to free @data, or %NULL
  *
@@ -31716,7 +31731,7 @@
  * Creates a new #GSocketConnectable for connecting to the given
  * @hostname and @port.
  *
- * Returns: (transfer full): the new #GNetworkAddress
+ * Returns: (transfer full) (type GNetworkAddress): the new #GNetworkAddress
  * Since: 2.22
  */
 
@@ -31915,7 +31930,7 @@
  * @protocol, and @domain. This will initially be unresolved; use the
  * #GSocketConnectable interface to resolve it.
  *
- * Returns: (transfer full): a new #GNetworkService
+ * Returns: (transfer full) (type GNetworkService): a new #GNetworkService
  * Since: 2.22
  */
 
@@ -32347,6 +32362,7 @@
  *
  * On error -1 is returned and @error is set accordingly.
  *
+ * Virtual: write_fn
  * Returns: Number of bytes written, or -1 on error
  */
 
@@ -34767,7 +34783,7 @@
 /**
  * g_simple_action_group_add_entries:
  * @simple: a #GSimpleActionGroup
- * @entries: a pointer to the first item in an array of #GActionEntry structs
+ * @entries: (array length=n_entries): a pointer to the first item in an array of #GActionEntry structs
  * @n_entries: the length of @entries, or -1
  * @user_data: the user data for signal connections
  *
@@ -36865,8 +36881,8 @@
 /**
  * g_socket_receive_from:
  * @socket: a #GSocket
- * @address: a pointer to a #GSocketAddress pointer, or %NULL
- * @buffer: a buffer to read data into (which should be at least @size bytes long).
+ * @address: (out) (allow-none): a pointer to a #GSocketAddress pointer, or %NULL
+ * @buffer: (array length=size) (element-type guint8): a buffer to read data into (which should be at least @size bytes long).
  * @size: the number of bytes you want to read from the socket
  * @cancellable: (allow-none): a %GCancellable or %NULL
  * @error: #GError for error reporting, or %NULL to ignore.
@@ -36889,7 +36905,7 @@
 /**
  * g_socket_receive_message:
  * @socket: a #GSocket
- * @address: a pointer to a #GSocketAddress pointer, or %NULL
+ * @address: (out) (allow-none): a pointer to a #GSocketAddress pointer, or %NULL
  * @vectors: (array length=num_vectors): an array of #GInputVector structs
  * @num_vectors: the number of elements in @vectors, or -1
  * @messages: (array length=num_messages) (allow-none): a pointer which may be filled with an array of #GSocketControlMessages, or %NULL
@@ -36986,7 +37002,7 @@
 /**
  * g_socket_send:
  * @socket: a #GSocket
- * @buffer: (array length=size): the buffer containing the data to send.
+ * @buffer: (array length=size) (element-type guint8): the buffer containing the data to send.
  * @size: the number of bytes to send
  * @cancellable: (allow-none): a %GCancellable or %NULL
  * @error: #GError for error reporting, or %NULL to ignore.
@@ -37074,7 +37090,7 @@
  * g_socket_send_to:
  * @socket: a #GSocket
  * @address: a #GSocketAddress, or %NULL
- * @buffer: (array length=size): the buffer containing the data to send.
+ * @buffer: (array length=size) (element-type guint8): the buffer containing the data to send.
  * @size: the number of bytes to send
  * @cancellable: (allow-none): a %GCancellable or %NULL
  * @error: #GError for error reporting, or %NULL to ignore.
@@ -37095,7 +37111,7 @@
 /**
  * g_socket_send_with_blocking:
  * @socket: a #GSocket
- * @buffer: (array length=size): the buffer containing the data to send.
+ * @buffer: (array length=size) (element-type guint8): the buffer containing the data to send.
  * @size: the number of bytes to send
  * @blocking: whether to do blocking or non-blocking I/O
  * @cancellable: (allow-none): a %GCancellable or %NULL
@@ -37484,7 +37500,7 @@
  *
  * Creates a new themed icon for @iconname.
  *
- * Returns: (transfer full): a new #GThemedIcon.
+ * Returns: (transfer full) (type GThemedIcon): a new #GThemedIcon.
  */
 
 
@@ -37495,7 +37511,7 @@
  *
  * Creates a new themed icon for @iconnames.
  *
- * Returns: (transfer full): a new #GThemedIcon
+ * Returns: (transfer full) (type GThemedIcon): a new #GThemedIcon
  */
 
 
@@ -37519,7 +37535,7 @@
  * icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio");
  * ]|
  *
- * Returns: (transfer full): a new #GThemedIcon.
+ * Returns: (transfer full) (type GThemedIcon): a new #GThemedIcon.
  */
 
 
@@ -37819,7 +37835,9 @@
  * must have pollable input and output streams) which is assumed to
  * communicate with the server identified by @server_identity.
  *
- * Returns: (transfer full): the new #GTlsClientConnection, or %NULL on error
+ * #GTlsClientConnection, or %NULL on error
+ *
+ * Returns: (transfer full) (type GTlsClientConnection): the new
  * Since: 2.28
  */
 
@@ -38349,9 +38367,9 @@
  * This function can block, use g_tls_database_lookup_certificates_issued_by_async() to perform
  * the lookup operation asynchronously.
  *
- * Use g_object_unref() on each certificate, and g_list_free() on the release the list.
+ * objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list.
  *
- * Returns: (transfer full): a newly allocated list of #GTlsCertificate objects.
+ * Returns: (transfer full) (element-type GTlsCertificate): a newly allocated list of #GTlsCertificate
  * Since: 2.30
  */
 
@@ -38491,7 +38509,9 @@
  *
  * The certificates in @anchors must be PEM encoded.
  *
- * Returns: (transfer full): the new #GTlsFileDatabase, or %NULL on error
+ * #GTlsFileDatabase, or %NULL on error
+ *
+ * Returns: (transfer full) (type GTlsFileDatabase): the new
  * Since: 2.30
  */
 
@@ -38717,6 +38737,7 @@
  * @length if using a null-terminated password, and @length will be calculated
  * automatically.
  *
+ * Virtual: set_value
  * Since: 2.30
  */
 
@@ -38743,7 +38764,9 @@
  * Creates a new #GTlsServerConnection wrapping @base_io_stream (which
  * must have pollable input and output streams).
  *
- * Returns: (transfer full): the new #GTlsServerConnection, or %NULL on error
+ * #GTlsServerConnection, or %NULL on error
+ *
+ * Returns: (transfer full) (type GTlsServerConnection): the new
  * Since: 2.28
  */
 
diff --git a/gir/glib-2.0.c b/gir/glib-2.0.c
index 5580715..e7756af 100644
--- a/gir/glib-2.0.c
+++ b/gir/glib-2.0.c
@@ -11474,10 +11474,10 @@
  * }
  *
  * void
- * set_insert (GHashTable *set,
+ * set_add (GHashTable *set,
  * gpointer    element)
  * {
- * g_hash_table_insert (set, element, element);
+ * g_hash_table_replace (set, element, element);
  * }
  *
  * gboolean
@@ -20050,7 +20050,7 @@
  * for which @predicate evaluates to %TRUE. If no pair with the
  * requested property is found, %NULL is returned.
  *
- * Returns: The value of the first key/value pair is returned,
+ * Returns: (allow-none): The value of the first key/value pair is returned,
  * Since: 2.4
  */
 
@@ -20275,7 +20275,7 @@
  * and has the value %NULL. If you need this distinction, use
  * g_hash_table_lookup_extended().
  *
- * Returns: the associated value, or %NULL if the key is not found
+ * Returns: (allow-none): the associated value, or %NULL if the key is not found
  */
 
 
@@ -20283,8 +20283,8 @@
  * g_hash_table_lookup_extended:
  * @hash_table: a #GHashTable
  * @lookup_key: the key to look up
- * @orig_key: return location for the original key, or %NULL
- * @value: return location for the value associated with the key, or %NULL
+ * @orig_key: (allow-none): return location for the original key, or %NULL
+ * @value: (allow-none): return location for the value associated with the key, or %NULL
  *
  * Looks up a key in the #GHashTable, returning the original key and the
  * associated value and a #gboolean which is %TRUE if the key was found. This
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]