From 72e6b0a415a7a4d4f858d92dd07347aa1a44285a Mon Sep 17 00:00:00 2001 From: Simon McVittie Date: Tue, 31 May 2011 15:57:44 +0100 Subject: [PATCH 13/14] DBusGProxy: misc documentation tidying --- dbus/dbus-gproxy.c | 37 +++++++++++++++++++++++++-------- doc/reference/dbus-glib-sections.txt | 4 +++ 2 files changed, 32 insertions(+), 9 deletions(-) diff --git a/dbus/dbus-gproxy.c b/dbus/dbus-gproxy.c index a34a5ca..f39c5b7 100644 --- a/dbus/dbus-gproxy.c +++ b/dbus/dbus-gproxy.c @@ -1895,10 +1895,11 @@ manager_begin_bus_call (DBusGProxyManager *manager, /** * SECTION:dbus-gproxy * @short_description: DBus Proxy - * @see_also: #DBusProxy + * @see_also: #DBusGProxy * @stability: Stable * - * A #DBusGProxy is a boxed type abstracting a #DBusProxy. + * A #DBusGProxy is a #GObject representing a remote object in a D-Bus + * service. */ /* @@ -2193,9 +2194,10 @@ dbus_g_proxy_set_interface (DBusGProxy *proxy, /** * dbus_g_proxy_get_path: - * Gets the path this proxy is bound to * @proxy: the proxy * + * Gets the path this proxy is bound to + * * It is an error to call this method on a proxy that has emitted * the #DBusGProxy::destroy signal. * @@ -2485,7 +2487,10 @@ dbus_g_proxy_end_call_internal (DBusGProxy *proxy, * @notify: callback to be invoked when method returns * @user_data: user data passed to callback * @destroy: function called to destroy user_data - * @first_arg_type: type of the first argument + * @first_arg_type: type of the first argument, or %G_TYPE_INVALID if there + * are no arguments + * @...: first argument, followed by any further type/value pairs, followed + * by %G_TYPE_INVALID * * Asynchronously invokes a method on a remote interface. The method * call will not be sent over the wire until the application returns @@ -2542,7 +2547,10 @@ dbus_g_proxy_begin_call (DBusGProxy *proxy, * @user_data: user data passed to callback * @destroy: function called to destroy user_data * @timeout: the timeout in milliseconds, or -1 to use a default - * @first_arg_type: type of the first argument + * @first_arg_type: type of the first argument, or %G_TYPE_INVALID if there + * are no arguments + * @...: first argument, followed by any further type/value pairs, followed + * by %G_TYPE_INVALID * * Asynchronously invokes a method on a remote interface. The method * call will not be sent over the wire until the application returns @@ -2597,7 +2605,10 @@ dbus_g_proxy_begin_call_with_timeout (DBusGProxy *proxy, * @proxy: a proxy for a remote interface * @call: the pending call ID from dbus_g_proxy_begin_call() * @error: return location for an error - * @first_arg_type: type of first "out" argument + * @first_arg_type: type of first "out" argument, or %G_TYPE_INVALID if + * there are no "out" arguments + * @...: return location for first "out" argument, followed by any further + * type/location pairs, followed by %G_TYPE_INVALID * * Collects the results of a method call. The method call was normally * initiated with dbus_g_proxy_end_call(). You may use this function @@ -2640,7 +2651,10 @@ dbus_g_proxy_end_call (DBusGProxy *proxy, * @proxy: a proxy for a remote interface * @method: method to invoke * @error: return location for an error - * @first_arg_type: type of first "in" argument + * @first_arg_type: type of first "in" argument, or %G_TYPE_INVALID if none + * @...: value of first "in" argument, any further type/value pairs, + * %G_TYPE_INVALID, type/location pairs for "out" arguments, + * and %G_TYPE_INVALID again * * Function for synchronously invoking a method and receiving reply * values. This function is equivalent to dbus_g_proxy_begin_call @@ -2705,6 +2719,7 @@ dbus_g_proxy_call (DBusGProxy *proxy, * @timeout: the timeout in milliseconds, or -1 to use a default * @error: return location for an error * @first_arg_type: type of first "in" argument + * @...: as for dbus_g_proxy_call() * * Function for synchronously invoking a method and receiving reply * values. This function is equivalent to dbus_g_proxy_begin_call @@ -2756,7 +2771,10 @@ dbus_g_proxy_call_with_timeout (DBusGProxy *proxy, * dbus_g_proxy_call_no_reply: * @proxy: a proxy for a remote interface * @method: the name of the method to invoke - * @first_arg_type: type of the first argument + * @first_arg_type: type of the first argument, or %G_TYPE_INVALID to call + * the method without arguments + * @...: the first argument and any remaining type/argument pairs, followed by + * %G_TYPE_INVALID to terminate the list * * Sends a method call message as with dbus_g_proxy_begin_call(), but * does not ask for a reply or allow you to receive one. @@ -2906,7 +2924,8 @@ array_free_all (gpointer array) * dbus_g_proxy_add_signal: * @proxy: the proxy for a remote interface * @signal_name: the name of the signal - * @first_type: the first argument type, or G_TYPE_INVALID if none + * @first_type: the first argument type, or %G_TYPE_INVALID if none + * @...: any subsequent argument types, followed by %G_TYPE_INVALID * * Specifies the argument signature of a D-Bus signal. When the signal is * emitted by the remote object, if the GTypes corresponding to its arguments' diff --git a/doc/reference/dbus-glib-sections.txt b/doc/reference/dbus-glib-sections.txt index fce4c7a..0c18675 100644 --- a/doc/reference/dbus-glib-sections.txt +++ b/doc/reference/dbus-glib-sections.txt @@ -75,6 +75,8 @@ DBUS_GERROR DBusGProxy dbus/dbus-glib.h DBusGProxy +DBusGProxyCall +DBusGProxyCallNotify dbus_g_proxy_new_for_name dbus_g_proxy_new_for_name_owner dbus_g_proxy_new_from_proxy @@ -103,6 +105,8 @@ dbus_g_proxy_get_type DBUS_G_PROXY_CLASS DBUS_IS_G_PROXY_CLASS DBUS_G_PROXY_GET_CLASS + +DBusGAsyncData
-- 1.7.5.3