GNOME.org
 

[libsoup] Soup-2.4.gir: add missing introspection data from Vala bindings

commit 08d2505a429ba408ba47de50e29ea5ea57aefb4d
Author: Evan Nemerson <evan coeus-group com>
Date:   Wed Aug 3 16:27:30 2011 -0700

    Soup-2.4.gir: add missing introspection data from Vala bindings
    
    https://bugzilla.gnome.org/show_bug.cgi?id=655397

 libsoup/soup-address.c            |   17 ++++++++++-------
 libsoup/soup-address.h            |    2 +-
 libsoup/soup-content-sniffer.c    |   15 +++++++++++++++
 libsoup/soup-cookie-jar.c         |    4 ++--
 libsoup/soup-headers.c            |   12 ++++++------
 libsoup/soup-message-body.c       |    4 ++--
 libsoup/soup-message-headers.c    |   19 +++++++++++--------
 libsoup/soup-multipart.c          |    6 ++++--
 libsoup/soup-proxy-uri-resolver.c |    2 +-
 libsoup/soup-session.c            |    4 ++--
 libsoup/soup-socket.c             |    6 +++---
 libsoup/soup-uri.c                |    9 +++++----
 libsoup/soup-xmlrpc.c             |    2 +-
 13 files changed, 63 insertions(+), 39 deletions(-)
---
diff --git a/libsoup/soup-address.c b/libsoup/soup-address.c
index fa625e1..0e5e8cd 100644
--- a/libsoup/soup-address.c
+++ b/libsoup/soup-address.c
@@ -713,7 +713,7 @@ idle_complete_resolve (gpointer addr)
  * @addr: the #SoupAddress that was resolved
  * @status: %SOUP_STATUS_OK, %SOUP_STATUS_CANT_RESOLVE, or
  * %SOUP_STATUS_CANCELLED
- * @data: the user data that was passed to
+ * @user_data: the user data that was passed to
  * soup_address_resolve_async()
  *
  * The callback function passed to soup_address_resolve_async().
@@ -914,7 +914,7 @@ soup_address_is_resolved (SoupAddress *addr)
 
 /**
  * soup_address_hash_by_name:
- * @addr: a #SoupAddress
+ * @addr: (type Soup.Address): a #SoupAddress
  *
  * A hash function (for #GHashTable) that corresponds to
  * soup_address_equal_by_name(), qv
@@ -934,8 +934,9 @@ soup_address_hash_by_name (gconstpointer addr)
 
 /**
  * soup_address_equal_by_name:
- * @addr1: a #SoupAddress with a resolved name
- * @addr2: another #SoupAddress with a resolved name
+ * @addr1: (type Soup.Address): a #SoupAddress with a resolved name
+ * @addr2: (type Soup.Address): another #SoupAddress with a resolved
+ *   name
  *
  * Tests if @addr1 and @addr2 have the same "name". This method can be
  * used with soup_address_hash_by_name() to create a #GHashTable that
@@ -976,7 +977,7 @@ soup_address_equal_by_name (gconstpointer addr1, gconstpointer addr2)
 
 /**
  * soup_address_hash_by_ip:
- * @addr: a #SoupAddress
+ * @addr: (type Soup.Address): a #SoupAddress
  *
  * A hash function (for #GHashTable) that corresponds to
  * soup_address_equal_by_ip(), qv
@@ -1000,8 +1001,10 @@ soup_address_hash_by_ip (gconstpointer addr)
 
 /**
  * soup_address_equal_by_ip:
- * @addr1: a #SoupAddress with a resolved IP address
- * @addr2: another #SoupAddress with a resolved IP address
+ * @addr1: (type Soup.Address): a #SoupAddress with a resolved IP
+ *   address
+ * @addr2: (type Soup.Address): another #SoupAddress with a resolved
+ *   IP address
  *
  * Tests if @addr1 and @addr2 have the same IP address. This method
  * can be used with soup_address_hash_by_ip() to create a
diff --git a/libsoup/soup-address.h b/libsoup/soup-address.h
index a7023cb..3cea001 100644
--- a/libsoup/soup-address.h
+++ b/libsoup/soup-address.h
@@ -52,7 +52,7 @@ typedef enum {
 
 typedef void   (*SoupAddressCallback)            (SoupAddress         *addr,
 						  guint                status,
-						  gpointer             data);
+						  gpointer             user_data);
 
 GType soup_address_get_type (void);
 
diff --git a/libsoup/soup-content-sniffer.c b/libsoup/soup-content-sniffer.c
index de90a60..8d54771 100644
--- a/libsoup/soup-content-sniffer.c
+++ b/libsoup/soup-content-sniffer.c
@@ -80,6 +80,21 @@ soup_content_sniffer_new ()
 	return g_object_new (SOUP_TYPE_CONTENT_SNIFFER, NULL);
 }
 
+/**
+ * soup_content_sniffer_sniff:
+ * @sniffer: a #SoupContentSniffer
+ * @msg: the message to sniff
+ * @buffer: a buffer containing the start of @msg's response body
+ * @params: (element-type utf8 utf8) (out) (transfer full) (allow-none): return
+ *   location for Content-Type parameters (eg, "charset"), or %NULL
+ *
+ * Sniffs @buffer to determine its Content-Type. The result may also
+ * be influenced by the Content-Type declared in @msg's response
+ * headers.
+ *
+ * Return value: the sniffed Content-Type of @buffer; this will never be %NULL,
+ *   but may be "application/octet-stream".
+ */
 char *
 soup_content_sniffer_sniff (SoupContentSniffer *sniffer,
 			    SoupMessage *msg, SoupBuffer *buffer,
diff --git a/libsoup/soup-cookie-jar.c b/libsoup/soup-cookie-jar.c
index e429429..13bf238 100644
--- a/libsoup/soup-cookie-jar.c
+++ b/libsoup/soup-cookie-jar.c
@@ -624,8 +624,8 @@ request_unqueued (SoupSessionFeature *feature, SoupSession *session,
  * The cookies in the list are a copy of the original, so
  * you have to free them when you are done with them.
  *
- * Return value: (transfer full): a #GSList with all the cookies in
- * the @jar.
+ * Return value: (transfer full) (element-type Soup.Cookie): a #GSList
+ * with all the cookies in the @jar.
  *
  * Since: 2.26
  **/
diff --git a/libsoup/soup-headers.c b/libsoup/soup-headers.c
index 37f60a9..6baf70b 100644
--- a/libsoup/soup-headers.c
+++ b/libsoup/soup-headers.c
@@ -464,8 +464,8 @@ parse_list (const char *header, char delim)
  * "#something", where "something" does not itself contain commas,
  * except as part of quoted-strings.
  *
- * Return value: (transfer full): a #GSList of list elements, as
- * allocated strings
+ * Return value: (transfer full) (element-type utf8): a #GSList of
+ * list elements, as allocated strings
  **/
 GSList *
 soup_header_parse_list (const char *header)
@@ -497,8 +497,8 @@ sort_by_qval (const void *a, const void *b)
 /**
  * soup_header_parse_quality_list:
  * @header: a header value
- * @unacceptable: (out) (allow-none) (transfer full): on return, will
- * contain a list of unacceptable values
+ * @unacceptable: (out) (allow-none) (transfer full) (element-type utf8): on
+ * return, will contain a list of unacceptable values
  *
  * Parses a header whose content is a list of items with optional
  * "qvalue"s (eg, Accept, Accept-Charset, Accept-Encoding,
@@ -508,8 +508,8 @@ sort_by_qval (const void *a, const void *b)
  * items with qvalue 0. Either way, those items will be removed from
  * the main list.
  *
- * Return value: (transfer full): a #GSList of acceptable values (as
- * allocated strings), highest-qvalue first.
+ * Return value: (transfer full) (element-type utf8): a #GSList of
+ * acceptable values (as allocated strings), highest-qvalue first.
  **/
 GSList *
 soup_header_parse_quality_list (const char *header, GSList **unacceptable)
diff --git a/libsoup/soup-message-body.c b/libsoup/soup-message-body.c
index 689acf8..8f1b6a7 100644
--- a/libsoup/soup-message-body.c
+++ b/libsoup/soup-message-body.c
@@ -169,8 +169,8 @@ soup_buffer_new_subbuffer (SoupBuffer *parent, gsize offset, gsize length)
  * @data: data
  * @length: length of @data
  * @owner: pointer to an object that owns @data
- * @owner_dnotify: a function to free/unref @owner when the buffer is
- * freed
+ * @owner_dnotify: (allow-none): a function to free/unref @owner when
+ * the buffer is freed
  *
  * Creates a new #SoupBuffer containing @length bytes from @data. When
  * the #SoupBuffer is freed, it will call @owner_dnotify, passing
diff --git a/libsoup/soup-message-headers.c b/libsoup/soup-message-headers.c
index a350304..195a3b0 100644
--- a/libsoup/soup-message-headers.c
+++ b/libsoup/soup-message-headers.c
@@ -867,7 +867,7 @@ sort_ranges (gconstpointer a, gconstpointer b)
  * soup_message_headers_get_ranges:
  * @hdrs: a #SoupMessageHeaders
  * @total_length: the total_length of the response body
- * @ranges: return location for an array of #SoupRange
+ * @ranges: (out): return location for an array of #SoupRange
  * @length: the length of the returned array
  *
  * Parses @hdrs's Range header and returns an array of the requested
@@ -1212,8 +1212,8 @@ content_type_setter (SoupMessageHeaders *hdrs, const char *value)
 /**
  * soup_message_headers_get_content_type:
  * @hdrs: a #SoupMessageHeaders
- * @params: (out) (allow-none): return location for the Content-Type parameters (eg,
- * "charset"), or %NULL
+ * @params: (out) (allow-none) (transfer full): return location for
+ * the Content-Type parameters (eg, "charset"), or %NULL
  *
  * Looks up the "Content-Type" header in @hdrs, parses it, and returns
  * its value in * content_type and * params  @params can be %NULL if you
@@ -1241,7 +1241,8 @@ soup_message_headers_get_content_type (SoupMessageHeaders  *hdrs,
  * soup_message_headers_set_content_type:
  * @hdrs: a #SoupMessageHeaders
  * @content_type: the MIME type
- * @params: additional parameters, or %NULL
+ * @params: (allow-none) (element-type utf8 utf8): additional
+ * parameters, or %NULL
  *
  * Sets the "Content-Type" header in @hdrs to @content_type,
  * optionally with additional parameters specified in @params.
@@ -1259,9 +1260,10 @@ soup_message_headers_set_content_type (SoupMessageHeaders  *hdrs,
 /**
  * soup_message_headers_get_content_disposition:
  * @hdrs: a #SoupMessageHeaders
- * @disposition: return location for the disposition-type, or %NULL
- * @params: return location for the Content-Disposition parameters, or
- * %NULL
+ * @disposition: (out) (transfer full): return location for the
+ * disposition-type, or %NULL
+ * @params: (out) (transfer full) (element-type utf8 utf8): return
+ * location for the Content-Disposition parameters, or %NULL
  *
  * Looks up the "Content-Disposition" header in @hdrs, parses it, and
  * returns its value in * disposition and * params  @params can be
@@ -1314,7 +1316,8 @@ soup_message_headers_get_content_disposition (SoupMessageHeaders  *hdrs,
  * soup_message_headers_set_content_disposition:
  * @hdrs: a #SoupMessageHeaders
  * @disposition: the disposition-type
- * @params: additional parameters, or %NULL
+ * @params: (allow-none) (element-type utf8 utf8): additional
+ * parameters, or %NULL
  *
  * Sets the "Content-Disposition" header in @hdrs to @disposition,
  * optionally with additional parameters specified in @params.
diff --git a/libsoup/soup-multipart.c b/libsoup/soup-multipart.c
index 31d4aba..ee99920 100644
--- a/libsoup/soup-multipart.c
+++ b/libsoup/soup-multipart.c
@@ -248,8 +248,10 @@ soup_multipart_get_length (SoupMultipart *multipart)
  * soup_multipart_get_part:
  * @multipart: a #SoupMultipart
  * @part: the part number to get (counting from 0)
- * @headers: return location for the MIME part headers
- * @body: return location for the MIME part body
+ * @headers: (out) (transfer none): return location for the MIME part
+ * headers
+ * @body: (out) (transfer none): return location for the MIME part
+ * body
  *
  * Gets the indicated body part from @multipart.
  *
diff --git a/libsoup/soup-proxy-uri-resolver.c b/libsoup/soup-proxy-uri-resolver.c
index 9abdaf6..556ba78 100644
--- a/libsoup/soup-proxy-uri-resolver.c
+++ b/libsoup/soup-proxy-uri-resolver.c
@@ -75,7 +75,7 @@ soup_proxy_uri_resolver_get_proxy_uri_async (SoupProxyURIResolver  *proxy_uri_re
  * @proxy_uri_resolver: the #SoupProxyURIResolver
  * @uri: the #SoupURI you want a proxy for
  * @cancellable: a #GCancellable, or %NULL
- * @proxy_uri: on return, will contain the proxy URI
+ * @proxy_uri: (out): on return, will contain the proxy URI
  *
  * Synchronously determines a proxy URI to use for @uri. If @uri
  * should be sent via proxy, * proxy_uri will be set to the URI of the
diff --git a/libsoup/soup-session.c b/libsoup/soup-session.c
index 4c947ce..4cd0de3 100644
--- a/libsoup/soup-session.c
+++ b/libsoup/soup-session.c
@@ -1953,8 +1953,8 @@ soup_session_remove_feature_by_type (SoupSession *session, GType feature_type)
  * you want to see all features, you can pass %G_TYPE_SESSION_FEATURE
  * for @feature_type.)
  *
- * Return value: (transfer container): a list of features. You must
- * free the list, but not its contents
+ * Return value: (transfer container) (element-type Soup.SessionFeature):
+ * a list of features. You must free the list, but not its contents
  *
  * Since: 2.26
  **/
diff --git a/libsoup/soup-socket.c b/libsoup/soup-socket.c
index 8d11841..b2216d3 100644
--- a/libsoup/soup-socket.c
+++ b/libsoup/soup-socket.c
@@ -1227,7 +1227,7 @@ read_from_buf (SoupSocket *sock, gpointer buffer, gsize len, gsize *nread)
  * @sock: the socket
  * @buffer: buffer to read into
  * @len: size of @buffer in bytes
- * @nread: on return, the number of bytes read into @buffer
+ * @nread: (out): on return, the number of bytes read into @buffer
  * @cancellable: a #GCancellable, or %NULL
  * @error: error pointer
  *
@@ -1278,7 +1278,7 @@ soup_socket_read (SoupSocket *sock, gpointer buffer, gsize len,
  * @len: size of @buffer in bytes
  * @boundary: boundary to read until
  * @boundary_len: length of @boundary in bytes
- * @nread: on return, the number of bytes read into @buffer
+ * @nread: (out): on return, the number of bytes read into @buffer
  * @got_boundary: on return, whether or not the data in @buffer
  * ends with the boundary string
  * @cancellable: a #GCancellable, or %NULL
@@ -1376,7 +1376,7 @@ socket_write_watch (GObject *pollable, gpointer user_data)
  * @sock: the socket
  * @buffer: data to write
  * @len: size of @buffer, in bytes
- * @nwrote: on return, number of bytes written
+ * @nwrote: (out): on return, number of bytes written
  * @cancellable: a #GCancellable, or %NULL
  * @error: error pointer
  *
diff --git a/libsoup/soup-uri.c b/libsoup/soup-uri.c
index 8d8f8a8..b3c0437 100644
--- a/libsoup/soup-uri.c
+++ b/libsoup/soup-uri.c
@@ -574,7 +574,8 @@ append_uri_encoded (GString *str, const char *in, const char *extra_enc_chars)
 /**
  * soup_uri_encode:
  * @part: a URI part
- * @escape_extra: additional reserved characters to escape (or %NULL)
+ * @escape_extra: (allow-none): additional reserved characters to
+ * escape (or %NULL)
  *
  * This %<!-- -->-encodes the given URI part and returns the escaped
  * version in allocated memory, which the caller must free when it is
@@ -1077,7 +1078,7 @@ soup_uri_copy_host (SoupURI *uri)
 
 /**
  * soup_uri_host_hash:
- * @key: a #SoupURI
+ * @key: (type Soup.URI): a #SoupURI
  *
  * Hashes @key, considering only the scheme, host, and port.
  *
@@ -1098,8 +1099,8 @@ soup_uri_host_hash (gconstpointer key)
 
 /**
  * soup_uri_host_equal:
- * @v1: a #SoupURI
- * @v2: a #SoupURI
+ * @v1: (type Soup.URI): a #SoupURI
+ * @v2: (type Soup.URI): a #SoupURI
  *
  * Compares @v1 and @v2, considering only the scheme, host, and port.
  *
diff --git a/libsoup/soup-xmlrpc.c b/libsoup/soup-xmlrpc.c
index ccd2568..71bf270 100644
--- a/libsoup/soup-xmlrpc.c
+++ b/libsoup/soup-xmlrpc.c
@@ -124,7 +124,7 @@ insert_value (xmlNode *parent, GValue *value)
 /**
  * soup_xmlrpc_build_method_call:
  * @method_name: the name of the XML-RPC method
- * @params: arguments to @method
+ * @params: (array length=n_params): arguments to @method
  * @n_params: length of @params
  *
  * This creates an XML-RPC methodCall and returns it as a string.
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]