Annotate all hash table parameters and return values for introspection

https://bugzilla.gnome.org/show_bug.cgi?id=619086

diff --git a/libsoup/soup-form.c b/libsoup/soup-form.c
index 477e0c7..e4f15e8 100644 (file)
--- a/libsoup/soup-form.c
+++ b/libsoup/soup-form.c
@@ -140,9 +140,10 @@ soup_form_decode (const char *encoded_form)
  * need to decode it manually, using soup_multipart_new_from_message()
  * and soup_multipart_get_part().
  *
- * Return value: a hash table containing the name/value pairs (other
- * than @file_control_name) from @msg, which you can free with
- * g_hash_table_destroy(). On error, it will return %NULL.
+ * Return value: (element-type utf8 utf8): a hash table containing the
+ * name/value pairs (other than @file_control_name) from @msg, which
+ * you can free with g_hash_table_destroy(). On error, it will return
+ * %NULL.
  *
  * Since: 2.26
  **/

diff --git a/libsoup/soup-headers.c b/libsoup/soup-headers.c
index 9a48e3d..2340883 100644 (file)
--- a/libsoup/soup-headers.c
+++ b/libsoup/soup-headers.c
@@ -748,7 +748,7 @@ parse_param_list (const char *header, char delim)
  * for giving UTF8-encoded filenames in the Content-Disposition
  * header).
  *
- * Return value: a #GHashTable of list elements, which can be freed
+ * Return value: (element-type utf8 utf8): a #GHashTable of list elements, which can be freed
  * with soup_header_free_param_list().
  **/
 GHashTable *
@@ -773,8 +773,8 @@ soup_header_parse_param_list (const char *header)
  * for giving UTF8-encoded filenames in the Content-Disposition
  * header).
  *
- * Return value: a #GHashTable of list elements, which can be freed
- * with soup_header_free_param_list().
+ * Return value: (element-type utf8 utf8): a #GHashTable of list
+ * elements, which can be freed with soup_header_free_param_list().
  *
  * Since: 2.24
  **/
@@ -788,7 +788,7 @@ soup_header_parse_semi_param_list (const char *header)
 
 /**
  * soup_header_free_param_list:
- * @param_list: a #GHashTable returned from soup_header_parse_param_list()
+ * @param_list: (element-type utf8 utf8): a #GHashTable returned from soup_header_parse_param_list()
  * or soup_header_parse_semi_param_list()
  *
  * Frees @param_list.

diff --git a/libsoup/soup-message.c b/libsoup/soup-message.c
index 160a0bd..b25a143 100644 (file)
--- a/libsoup/soup-message.c
+++ b/libsoup/soup-message.c
@@ -420,7 +420,7 @@ soup_message_class_init (SoupMessageClass *message_class)
         * SoupMessage::content-sniffed:
         * @msg: the message
         * @type: the content type that we got from sniffing
-        * @params: a #GHashTable with the parameters
+        * @params: (element-type utf8 utf8): a #GHashTable with the parameters
         *
         * This signal is emitted after %got-headers, and before the
         * first %got-chunk. If content sniffing is disabled, or no

diff --git a/libsoup/soup-uri.c b/libsoup/soup-uri.c
index c5c8c3e..a3353a9 100644 (file)
--- a/libsoup/soup-uri.c
+++ b/libsoup/soup-uri.c
@@ -979,7 +979,7 @@ soup_uri_set_query (SoupURI *uri, const char *query)
 /**
  * soup_uri_set_query_from_form:
  * @uri: a #SoupURI
- * @form: a #GHashTable containing HTML form information
+ * @form: (element-type utf8 utf8): a #GHashTable containing HTML form information
  *
  * Sets @uri's query to the result of encoding @form according to the
  * HTML form rules. See soup_form_encode_hash() for more information.

diff --git a/libsoup/soup-value-utils.c b/libsoup/soup-value-utils.c
index 34ad225..098dbdd 100644 (file)
--- a/libsoup/soup-value-utils.c
+++ b/libsoup/soup-value-utils.c
@@ -56,7 +56,7 @@ soup_value_hash_value_free (gpointer val)
  * Creates a #GHashTable whose keys are strings and whose values
  * are #GValue.
  *
- * Return value: a new empty #GHashTable
+ * Return value: (element-type utf8 GValue): a new empty #GHashTable
  **/
 GHashTable *
 soup_value_hash_new (void)
@@ -94,7 +94,7 @@ soup_value_hash_insert_valist (GHashTable *hash, const char *first_key,
  * with soup_value_hash_insert(), the keys and values are copied
  * rather than being inserted directly.
  *
- * Return value: a new #GHashTable, initialized with the given values
+ * Return value: (element-type utf8 GValue): a new #GHashTable, initialized with the given values
  **/
 GHashTable *
 soup_value_hash_new_with_vals (const char *first_key, ...)
@@ -111,7 +111,7 @@ soup_value_hash_new_with_vals (const char *first_key, ...)
 
 /**
  * soup_value_hash_insert_value:
- * @hash: a value hash
+ * @hash: (element-type utf8 GValue): a value hash
  * @key: the key
  * @value: a value
  *
@@ -130,7 +130,7 @@ soup_value_hash_insert_value (GHashTable *hash, const char *key, GValue *value)
 
 /**
  * soup_value_hash_insert:
- * @hash: a value hash
+ * @hash: (element-type utf8 GValue): a value hash
  * @key: the key
  * @type: a #GType
  * @...: a value of type @type
@@ -152,7 +152,7 @@ soup_value_hash_insert (GHashTable *hash, const char *key, GType type, ...)
 
 /**
  * soup_value_hash_insert_vals:
- * @hash: a value hash
+ * @hash: (element-type utf8 GValue): a value hash
  * @first_key: the key for the first value
  * @...: the type of @first_key, followed by the value, followed
  * by additional key/type/value triplets, terminated by %NULL
@@ -173,7 +173,7 @@ soup_value_hash_insert_vals (GHashTable *hash, const char *first_key, ...)
 
 /**
  * soup_value_hash_lookup:
- * @hash: a value hash
+ * @hash: (element-type utf8 GValue): a value hash
  * @key: the key to look up
  * @type: a #GType
  * @...: a value of type pointer-to-@type
@@ -203,7 +203,7 @@ soup_value_hash_lookup (GHashTable *hash, const char *key, GType type, ...)
 
 /**
  * soup_value_hash_lookup_vals:
- * @hash: a value hash
+ * @hash: (element-type utf8 GValue): a value hash
  * @first_key: the first key to look up
  * @...: the type of @first_key, a pointer to that type, and
  * then additional key/type/pointer triplets, terminated