* @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().
/**
* 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
/**
* 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
/**
* 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
/**
* 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
typedef void (*SoupAddressCallback) (SoupAddress *addr,
guint status,
- gpointer data);
+ gpointer user_data);
GType soup_address_get_type (void);
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,
* 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
**/
* "#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)
/**
* 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,
* 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)
* @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
* 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
/**
* 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
* 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.
/**
* 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
* 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.
* 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.
*
* @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
* 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
**/
* @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
*
* @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
* @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
*
/**
* 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
/**
* soup_uri_host_hash:
- * @key: a #SoupURI
+ * @key: (type Soup.URI): a #SoupURI
*
* Hashes @key, considering only the scheme, host, and port.
*
/**
* 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.
*
/**
* 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.