From add8cf9c09255e497545c67ca81e8f8bf28f3f85 Mon Sep 17 00:00:00 2001 From: Pavel Holejsovsky Date: Wed, 29 Dec 2010 16:01:12 +0100 Subject: [PATCH] Add GI annotations to Gio highlevel network functionality --- gio/gsocketclient.c | 32 ++++++++++++++++---------------- gio/gsocketlistener.c | 28 ++++++++++++++-------------- gio/gunixconnection.c | 4 ++-- 3 files changed, 32 insertions(+), 32 deletions(-) diff --git a/gio/gsocketclient.c b/gio/gsocketclient.c index f1fe01b0e..bb60fcc9f 100644 --- a/gio/gsocketclient.c +++ b/gio/gsocketclient.c @@ -723,7 +723,7 @@ g_socket_client_class_init (GSocketClientClass *class) * g_socket_client_connect: * @client: a #GSocketClient. * @connectable: a #GSocketConnectable specifying the remote address. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: #GError for error reporting, or %NULL to ignore. * * Tries to resolve the @connectable and make a network connection to it.. @@ -905,7 +905,7 @@ g_socket_client_connect (GSocketClient *client, * @client: a #GSocketClient * @host_and_port: the name and optionally port of the host to connect to * @default_port: the default port to connect to - * @cancellable: a #GCancellable, or %NULL + * @cancellable: (allow-none): a #GCancellable, or %NULL * @error: a pointer to a #GError, or %NULL * * This is a helper function for g_socket_client_connect(). @@ -969,7 +969,7 @@ g_socket_client_connect_to_host (GSocketClient *client, * @client: a #GSocketConnection * @domain: a domain name * @service: the name of the service to connect to - * @cancellable: a #GCancellable, or %NULL + * @cancellable: (allow-none): a #GCancellable, or %NULL * @error: a pointer to a #GError, or %NULL * @returns: (transfer full): a #GSocketConnection if successful, or %NULL on error * @@ -1011,7 +1011,7 @@ g_socket_client_connect_to_service (GSocketClient *client, * @client: a #GSocketClient * @uri: A network URI * @default_port: the default port to connect to - * @cancellable: a #GCancellable, or %NULL + * @cancellable: (allow-none): a #GCancellable, or %NULL * @error: a pointer to a #GError, or %NULL * * This is a helper function for g_socket_client_connect(). @@ -1422,9 +1422,9 @@ g_socket_client_enumerator_callback (GObject *object, * g_socket_client_connect_async: * @client: a #GTcpClient * @connectable: a #GSocketConnectable specifying the remote address. - * @cancellable: a #GCancellable, or %NULL - * @callback: a #GAsyncReadyCallback - * @user_data: user data for the callback + * @cancellable: (allow-none): a #GCancellable, or %NULL + * @callback: (scope async): a #GAsyncReadyCallback + * @user_data: (closure): user data for the callback * * This is the asynchronous version of g_socket_client_connect(). * @@ -1471,9 +1471,9 @@ g_socket_client_connect_async (GSocketClient *client, * @client: a #GTcpClient * @host_and_port: the name and optionally the port of the host to connect to * @default_port: the default port to connect to - * @cancellable: a #GCancellable, or %NULL - * @callback: a #GAsyncReadyCallback - * @user_data: user data for the callback + * @cancellable: (allow-none): a #GCancellable, or %NULL + * @callback: (scope async): a #GAsyncReadyCallback + * @user_data: (closure): user data for the callback * * This is the asynchronous version of g_socket_client_connect_to_host(). * @@ -1516,9 +1516,9 @@ g_socket_client_connect_to_host_async (GSocketClient *client, * @client: a #GSocketClient * @domain: a domain name * @service: the name of the service to connect to - * @cancellable: a #GCancellable, or %NULL - * @callback: a #GAsyncReadyCallback - * @user_data: user data for the callback + * @cancellable: (allow-none): a #GCancellable, or %NULL + * @callback: (scope async): a #GAsyncReadyCallback + * @user_data: (closure): user data for the callback * * This is the asynchronous version of * g_socket_client_connect_to_service(). @@ -1547,9 +1547,9 @@ g_socket_client_connect_to_service_async (GSocketClient *client, * @client: a #GSocketClient * @uri: a network uri * @default_port: the default port to connect to - * @cancellable: a #GCancellable, or %NULL - * @callback: a #GAsyncReadyCallback - * @user_data: user data for the callback + * @cancellable: (allow-none): a #GCancellable, or %NULL + * @callback: (scope async): a #GAsyncReadyCallback + * @user_data: (closure): user data for the callback * * This is the asynchronous version of g_socket_client_connect_to_uri(). * diff --git a/gio/gsocketlistener.c b/gio/gsocketlistener.c index babefcdf2..ddfbffa8b 100644 --- a/gio/gsocketlistener.c +++ b/gio/gsocketlistener.c @@ -199,7 +199,7 @@ check_listener (GSocketListener *listener, * g_socket_listener_add_socket: * @listener: a #GSocketListener * @socket: a listening #GSocket - * @source_object: Optional #GObject identifying this source + * @source_object: (allow-none): Optional #GObject identifying this source * @error: #GError for error reporting, or %NULL to ignore. * * Adds @socket to the set of sockets that we try to accept @@ -253,7 +253,7 @@ g_socket_listener_add_socket (GSocketListener *listener, * @address: a #GSocketAddress * @type: a #GSocketType * @protocol: a #GSocketProtocol - * @source_object: Optional #GObject identifying this source + * @source_object: (allow-none): Optional #GObject identifying this source * @effective_address: (out) (allow-none): location to store the address that was bound to, or %NULL. * @error: #GError for error reporting, or %NULL to ignore. * @@ -344,7 +344,7 @@ g_socket_listener_add_address (GSocketListener *listener, * g_socket_listener_add_inet_port: * @listener: a #GSocketListener * @port: an IP port number (non-zero) - * @source_object: Optional #GObject identifying this source + * @source_object: (allow-none): Optional #GObject identifying this source * @error: #GError for error reporting, or %NULL to ignore. * * Helper function for g_socket_listener_add_address() that @@ -563,7 +563,7 @@ accept_callback (GSocket *socket, * g_socket_listener_accept_socket: * @listener: a #GSocketListener * @source_object: (out) (transfer none) (allow-none): location where #GObject pointer will be stored, or %NULL. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: #GError for error reporting, or %NULL to ignore. * * Blocks waiting for a client to connect to any of the sockets added @@ -640,7 +640,7 @@ g_socket_listener_accept_socket (GSocketListener *listener, * g_socket_listener_accept: * @listener: a #GSocketListener * @source_object: (out) (transfer none) (allow-none): location where #GObject pointer will be stored, or %NULL - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @error: #GError for error reporting, or %NULL to ignore. * * Blocks waiting for a client to connect to any of the sockets added @@ -724,9 +724,9 @@ accept_ready (GSocket *accept_socket, /** * g_socket_listener_accept_socket_async: * @listener: a #GSocketListener - * @cancellable: a #GCancellable, or %NULL - * @callback: a #GAsyncReadyCallback - * @user_data: user data for the callback + * @cancellable: (allow-none): a #GCancellable, or %NULL + * @callback: (scope async): a #GAsyncReadyCallback + * @user_data: (closure): user data for the callback * * This is the asynchronous version of g_socket_listener_accept_socket(). * @@ -769,7 +769,7 @@ g_socket_listener_accept_socket_async (GSocketListener *listener, * g_socket_listener_accept_socket_finish: * @listener: a #GSocketListener * @result: a #GAsyncResult. - * @source_object: Optional #GObject identifying this source + * @source_object: (out) (transfer none) (allow-none): Optional #GObject identifying this source * @error: a #GError location to store the error occuring, or %NULL to * ignore. * @@ -808,9 +808,9 @@ g_socket_listener_accept_socket_finish (GSocketListener *listener, /** * g_socket_listener_accept_async: * @listener: a #GSocketListener - * @cancellable: a #GCancellable, or %NULL - * @callback: a #GAsyncReadyCallback - * @user_data: user data for the callback + * @cancellable: (allow-none): a #GCancellable, or %NULL + * @callback: (scope async): a #GAsyncReadyCallback + * @user_data: (closure): user data for the callback * * This is the asynchronous version of g_socket_listener_accept(). * @@ -836,7 +836,7 @@ g_socket_listener_accept_async (GSocketListener *listener, * g_socket_listener_accept_finish: * @listener: a #GSocketListener * @result: a #GAsyncResult. - * @source_object: Optional #GObject identifying this source + * @source_object: (out) (transfer none) (allow-none): Optional #GObject identifying this source * @error: a #GError location to store the error occuring, or %NULL to * ignore. * @@ -927,7 +927,7 @@ g_socket_listener_close (GSocketListener *listener) /** * g_socket_listener_add_any_inet_port: * @listener: a #GSocketListener - * @source_object: Optional #GObject identifying this source + * @source_object: (allow-none): Optional #GObject identifying this source * @error: a #GError location to store the error occuring, or %NULL to * ignore. * diff --git a/gio/gunixconnection.c b/gio/gunixconnection.c index 82510f5c9..7106fb7ab 100644 --- a/gio/gunixconnection.c +++ b/gio/gunixconnection.c @@ -304,7 +304,7 @@ gboolean g_unix_connection_create_pair (GUnixCo /** * g_unix_connection_send_credentials: * @connection: A #GUnixConnection. - * @cancellable: A #GCancellable or %NULL. + * @cancellable: (allow-none): A #GCancellable or %NULL. * @error: Return location for error or %NULL. * * Passes the credentials of the current user the receiving side @@ -372,7 +372,7 @@ g_unix_connection_send_credentials (GUnixConnection *connection, /** * g_unix_connection_receive_credentials: * @connection: A #GUnixConnection. - * @cancellable: A #GCancellable or %NULL. + * @cancellable: (allow-none): A #GCancellable or %NULL. * @error: Return location for error or %NULL. * * Receives credentials from the sending end of the connection. The