GNOME.org
 

[libsoup] Update gi annotations

commit a8a44b5cc82fe646425a2ed1ad96799894727103
Author: Patrick Griffis <pgriffis igalia com>
Date:   Sun Aug 8 13:57:29 2021 -0500

    Update gi annotations

 libsoup/cache/soup-cache.c                    |  2 +-
 libsoup/server/soup-server-message.c          |  4 ++--
 libsoup/server/soup-server.c                  | 22 +++++++++++-----------
 libsoup/soup-form.c                           |  8 ++++----
 libsoup/soup-headers.c                        | 20 ++++++++++----------
 libsoup/soup-message-headers.c                |  6 +++---
 libsoup/soup-message.c                        |  8 ++++----
 libsoup/soup-misc.c                           |  4 ++--
 libsoup/soup-session.c                        |  6 +++---
 libsoup/websocket/soup-websocket-connection.c |  6 +++---
 10 files changed, 43 insertions(+), 43 deletions(-)
---
diff --git a/libsoup/cache/soup-cache.c b/libsoup/cache/soup-cache.c
index 2ff9777d..550c37b0 100644
--- a/libsoup/cache/soup-cache.c
+++ b/libsoup/cache/soup-cache.c
@@ -1068,7 +1068,7 @@ soup_cache_class_init (SoupCacheClass *cache_class)
 
 /**
  * soup_cache_new:
- * @cache_dir: (allow-none): the directory to store the cached data, or %NULL
+ * @cache_dir: (nullable): the directory to store the cached data, or %NULL
  *   to use the default one. Note that since the cache isn't safe to access for
  *   multiple processes at once, and the default directory isn't namespaced by
  *   process, clients are strongly discouraged from passing %NULL.
diff --git a/libsoup/server/soup-server-message.c b/libsoup/server/soup-server-message.c
index d2a33164..641942ec 100644
--- a/libsoup/server/soup-server-message.c
+++ b/libsoup/server/soup-server-message.c
@@ -751,9 +751,9 @@ soup_server_message_get_uri (SoupServerMessage *msg)
 /**
  * soup_server_message_set_response:
  * @msg: the message
- * @content_type: (allow-none): MIME Content-Type of the body
+ * @content_type: (nullable): MIME Content-Type of the body
  * @resp_use: a #SoupMemoryUse describing how to handle @resp_body
- * @resp_body: (allow-none) (array length=resp_length) (element-type guint8):
+ * @resp_body: (nullable) (array length=resp_length) (element-type guint8):
  *   a data buffer containing the body of the message response.
  * @resp_length: the byte length of @resp_body.
  *
diff --git a/libsoup/server/soup-server.c b/libsoup/server/soup-server.c
index 2ff76eb8..80e67129 100644
--- a/libsoup/server/soup-server.c
+++ b/libsoup/server/soup-server.c
@@ -1083,8 +1083,8 @@ start_request (SoupServer        *server,
  * soup_server_accept_iostream:
  * @server: a #SoupServer
  * @stream: a #GIOStream
- * @local_addr: (allow-none): the local #GSocketAddress associated with the @stream
- * @remote_addr: (allow-none): the remote #GSocketAddress associated with the @stream
+ * @local_addr: (nullable): the local #GSocketAddress associated with the @stream
+ * @remote_addr: (nullable): the remote #GSocketAddress associated with the @stream
  * @error: return location for a #GError
  *
  * Add a new client stream to the @server.
@@ -1581,7 +1581,7 @@ soup_server_get_uris (SoupServer *server)
  * @server: the #SoupServer
  * @msg: the message being processed
  * @path: the path component of @msg's Request-URI
- * @query: (element-type utf8 utf8) (allow-none): the parsed query
+ * @query: (element-type utf8 utf8) (nullable): the parsed query
  *   component of @msg's Request-URI
  * @user_data: the data passed to soup_server_add_handler() or
  *   soup_server_add_early_handler().
@@ -1631,8 +1631,8 @@ get_or_create_handler (SoupServer *server, const char *exact_path)
 /**
  * soup_server_add_handler:
  * @server: a #SoupServer
- * @path: (allow-none): the toplevel path for the handler
- * @callback: callback to invoke for requests under @path
+ * @path: (nullable): the toplevel path for the handler
+ * @callback: (scope notified) (destroy destroy): callback to invoke for requests under @path
  * @user_data: data for @callback
  * @destroy: destroy notifier to free @user_data
  *
@@ -1696,8 +1696,8 @@ soup_server_add_handler (SoupServer            *server,
 /**
  * soup_server_add_early_handler:
  * @server: a #SoupServer
- * @path: (allow-none): the toplevel path for the handler
- * @callback: callback to invoke for requests under @path
+ * @path: (nullable): the toplevel path for the handler
+ * @callback: (scope notified) (destroy destroy): callback to invoke for requests under @path
  * @user_data: data for @callback
  * @destroy: destroy notifier to free @user_data
  *
@@ -1771,11 +1771,11 @@ soup_server_add_early_handler (SoupServer            *server,
 /**
  * soup_server_add_websocket_handler:
  * @server: a #SoupServer
- * @path: (allow-none): the toplevel path for the handler
- * @origin: (allow-none): the origin of the connection
- * @protocols: (allow-none) (array zero-terminated=1): the protocols
+ * @path: (nullable): the toplevel path for the handler
+ * @origin: (nullable): the origin of the connection
+ * @protocols: (nullable) (array zero-terminated=1): the protocols
  *   supported by this handler
- * @callback: callback to invoke for successful WebSocket requests under @path
+ * @callback: (scope notified) (destroy destroy): callback to invoke for successful WebSocket requests under 
@path
  * @user_data: data for @callback
  * @destroy: destroy notifier to free @user_data
  *
diff --git a/libsoup/soup-form.c b/libsoup/soup-form.c
index 08e5ada7..b11dc047 100644
--- a/libsoup/soup-form.c
+++ b/libsoup/soup-form.c
@@ -111,10 +111,10 @@ soup_form_decode (const char *encoded_form)
 /**
  * soup_form_decode_multipart:
  * @multipart: a #SoupMultipart
- * @file_control_name: (allow-none): the name of the HTML file upload control, or %NULL
- * @filename: (out) (allow-none): return location for the name of the uploaded file, or %NULL
- * @content_type: (out) (allow-none): return location for the MIME type of the uploaded file, or %NULL
- * @file: (out) (allow-none): return location for the uploaded file data, or %NULL
+ * @file_control_name: (nullable): the name of the HTML file upload control, or %NULL
+ * @filename: (out) (optional): return location for the name of the uploaded file, or %NULL
+ * @content_type: (out) (optional): return location for the MIME type of the uploaded file, or %NULL
+ * @file: (out) (optional): return location for the uploaded file data, or %NULL
  *
  * Decodes the "multipart/form-data" request in @multipart; this is a
  * convenience method for the case when you have a single file upload
diff --git a/libsoup/soup-headers.c b/libsoup/soup-headers.c
index 87779fcf..fccd0ea9 100644
--- a/libsoup/soup-headers.c
+++ b/libsoup/soup-headers.c
@@ -169,11 +169,11 @@ done:
  * @str: the headers (up to, but not including, the trailing blank line)
  * @len: length of @str
  * @req_headers: #SoupMessageHeaders to store the header values in
- * @req_method: (out) (allow-none): if non-%NULL, will be filled in with the
+ * @req_method: (out) (optional): if non-%NULL, will be filled in with the
  * request method
- * @req_path: (out) (allow-none): if non-%NULL, will be filled in with the
+ * @req_path: (out) (optional): if non-%NULL, will be filled in with the
  * request path
- * @ver: (out) (allow-none): if non-%NULL, will be filled in with the HTTP
+ * @ver: (out) (optional): if non-%NULL, will be filled in with the HTTP
  * version
  *
  * Parses the headers of an HTTP request in @str and stores the
@@ -279,11 +279,11 @@ soup_headers_parse_request (const char          *str,
 /**
  * soup_headers_parse_status_line:
  * @status_line: an HTTP Status-Line
- * @ver: (out) (allow-none): if non-%NULL, will be filled in with the HTTP
+ * @ver: (out) (optional): if non-%NULL, will be filled in with the HTTP
  * version
- * @status_code: (out) (allow-none): if non-%NULL, will be filled in with
+ * @status_code: (out) (optional): if non-%NULL, will be filled in with
  * the status code
- * @reason_phrase: (out) (allow-none): if non-%NULL, will be filled in with
+ * @reason_phrase: (out) (optional): if non-%NULL, will be filled in with
  * the reason phrase
  *
  * Parses the HTTP Status-Line string in @status_line into @ver,
@@ -356,11 +356,11 @@ soup_headers_parse_status_line (const char       *status_line,
  * @str: the headers (up to, but not including, the trailing blank line)
  * @len: length of @str
  * @headers: #SoupMessageHeaders to store the header values in
- * @ver: (out) (allow-none): if non-%NULL, will be filled in with the HTTP
+ * @ver: (out) (optional): if non-%NULL, will be filled in with the HTTP
  * version
- * @status_code: (out) (allow-none): if non-%NULL, will be filled in with
+ * @status_code: (out) (optional): if non-%NULL, will be filled in with
  * the status code
- * @reason_phrase: (out) (allow-none): if non-%NULL, will be filled in with
+ * @reason_phrase: (out) (optional): if non-%NULL, will be filled in with
  * the reason phrase
  *
  * Parses the headers of an HTTP response in @str and stores the
@@ -525,7 +525,7 @@ sort_by_qval (const void *a, const void *b)
 /**
  * soup_header_parse_quality_list:
  * @header: a header value
- * @unacceptable: (out) (allow-none) (transfer full) (element-type utf8): on
+ * @unacceptable: (out) (optional) (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
diff --git a/libsoup/soup-message-headers.c b/libsoup/soup-message-headers.c
index 3ebfc7de..29d7966d 100644
--- a/libsoup/soup-message-headers.c
+++ b/libsoup/soup-message-headers.c
@@ -1527,7 +1527,7 @@ set_content_foo (SoupMessageHeaders *hdrs,
 /**
  * soup_message_headers_get_content_type:
  * @hdrs: a #SoupMessageHeaders
- * @params: (out) (element-type utf8 utf8) (allow-none) (transfer full):
+ * @params: (out) (element-type utf8 utf8) (optional) (transfer full):
  *   return location for the Content-Type parameters (eg, "charset"), or
  *   %NULL
  *
@@ -1557,7 +1557,7 @@ soup_message_headers_get_content_type (SoupMessageHeaders  *hdrs,
  * soup_message_headers_set_content_type:
  * @hdrs: a #SoupMessageHeaders
  * @content_type: the MIME type
- * @params: (allow-none) (element-type utf8 utf8): additional
+ * @params: (nullable) (element-type utf8 utf8): additional
  * parameters, or %NULL
  *
  * Sets the "Content-Type" header in @hdrs to @content_type,
@@ -1630,7 +1630,7 @@ soup_message_headers_get_content_disposition (SoupMessageHeaders  *hdrs,
  * soup_message_headers_set_content_disposition:
  * @hdrs: a #SoupMessageHeaders
  * @disposition: the disposition-type
- * @params: (allow-none) (element-type utf8 utf8): additional
+ * @params: (nullable) (element-type utf8 utf8): additional
  * parameters, or %NULL
  *
  * Sets the "Content-Disposition" header in @hdrs to @disposition,
diff --git a/libsoup/soup-message.c b/libsoup/soup-message.c
index 25984ef0..2f5b2670 100644
--- a/libsoup/soup-message.c
+++ b/libsoup/soup-message.c
@@ -1073,8 +1073,8 @@ soup_message_new_from_multipart (const char    *uri_string,
 /**
  * soup_message_set_request_body:
  * @msg: the message
- * @content_type: (allow-none): MIME Content-Type of the body, or %NULL if unknown
- * @stream: (allow-none): a #GInputStream to read the request body from
+ * @content_type: (nullable): MIME Content-Type of the body, or %NULL if unknown
+ * @stream: (nullable): a #GInputStream to read the request body from
  * @content_length: the byte length of @stream or -1 if unknown
  *
  * Set the request body of a #SoupMessage.
@@ -1120,8 +1120,8 @@ soup_message_set_request_body (SoupMessage  *msg,
 /**
  * soup_message_set_request_body_from_bytes:
  * @msg: the message
- * @content_type: (allow-none): MIME Content-Type of the body, or %NULL if unknown
- * @bytes: (allow-none): a #GBytes with the request body data
+ * @content_type: (nullable): MIME Content-Type of the body, or %NULL if unknown
+ * @bytes: (nullable): a #GBytes with the request body data
  *
  * Set the request body of a #SoupMessage from #GBytes.
  * If @content_type is %NULL and @bytes is not %NULL the Content-Type header will
diff --git a/libsoup/soup-misc.c b/libsoup/soup-misc.c
index 717bc8ca..5ef87994 100644
--- a/libsoup/soup-misc.c
+++ b/libsoup/soup-misc.c
@@ -69,7 +69,7 @@ soup_add_completion_reffed (GMainContext   *async_context,
 
 /*
  * soup_add_completion: (skip)
- * @async_context: (allow-none): the #GMainContext to dispatch the I/O
+ * @async_context: (nullable): the #GMainContext to dispatch the I/O
  * watch in, or %NULL for the default context
  * @function: the callback to invoke
  * @data: user data to pass to @function
@@ -91,7 +91,7 @@ soup_add_completion (GMainContext *async_context,
 
 /**
  * soup_add_timeout: (skip)
- * @async_context: (allow-none): the #GMainContext to dispatch the I/O
+ * @async_context: (nullable): the #GMainContext to dispatch the I/O
  * watch in, or %NULL for the default context
  * @interval: the timeout interval, in milliseconds
  * @function: the callback to invoke at timeout time
diff --git a/libsoup/soup-session.c b/libsoup/soup-session.c
index bc595faa..b4c3d583 100644
--- a/libsoup/soup-session.c
+++ b/libsoup/soup-session.c
@@ -3870,8 +3870,8 @@ websocket_connect_async_stop (SoupMessage *msg, gpointer user_data)
  * soup_session_websocket_connect_async:
  * @session: a #SoupSession
  * @msg: #SoupMessage indicating the WebSocket server to connect to
- * @origin: (allow-none): origin of the connection
- * @protocols: (allow-none) (array zero-terminated=1): a
+ * @origin: (nullable): origin of the connection
+ * @protocols: (nullable) (array zero-terminated=1): a
  *   %NULL-terminated array of protocols supported
  * @io_priority: the I/O priority of the request
  * @cancellable: (nullable): a #GCancellable
@@ -4010,7 +4010,7 @@ preconnect_async_complete (SoupMessage *msg,
  * @msg: a #SoupMessage
  * @io_priority: the I/O priority of the request
  * @cancellable: (nullable): a #GCancellable
- * @callback: (allow-none) (scope async): the callback to invoke when the operation finishes
+ * @callback: (nullable) (scope async): the callback to invoke when the operation finishes
  * @user_data: data for @progress_callback and @callback
  *
  * Start a preconnection to @msg. Once the connection is done, it will remain in idle state so that
diff --git a/libsoup/websocket/soup-websocket-connection.c b/libsoup/websocket/soup-websocket-connection.c
index a5511eab..35efaec4 100644
--- a/libsoup/websocket/soup-websocket-connection.c
+++ b/libsoup/websocket/soup-websocket-connection.c
@@ -1726,8 +1726,8 @@ soup_websocket_connection_class_init (SoupWebsocketConnectionClass *klass)
  * @stream: a #GIOStream connected to the WebSocket server
  * @uri: the URI of the connection
  * @type: the type of connection (client/side)
- * @origin: (allow-none): the Origin of the client
- * @protocol: (allow-none): the subprotocol in use
+ * @origin: (nullable): the Origin of the client
+ * @protocol: (nullable): the subprotocol in use
  * @extensions: (element-type SoupWebsocketExtension) (transfer full): a #GList of #SoupWebsocketExtension 
objects
  *
  * Creates a #SoupWebsocketConnection on @stream with the given active @extensions.
@@ -2034,7 +2034,7 @@ soup_websocket_connection_send_message (SoupWebsocketConnection *self,
  * soup_websocket_connection_close:
  * @self: the WebSocket
  * @code: close code
- * @data: (allow-none): close data
+ * @data: (nullable): close data
  *
  * Close the connection in an orderly fashion.
  *
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]