From 4390865bc0a6892c3df99946c4530c38b73ad26c Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Thu, 17 Mar 2011 11:27:30 -0500 Subject: [PATCH] libnm-glib: clarify usage of specific_object for activation calls --- libnm-glib/nm-client.c | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/libnm-glib/nm-client.c b/libnm-glib/nm-client.c index 5c56f1b32c..bc295ae993 100644 --- a/libnm-glib/nm-client.c +++ b/libnm-glib/nm-client.c @@ -653,9 +653,13 @@ activate_cb (DBusGProxy *proxy, * @client: a #NMClient * @connection: an #NMConnection * @device: (allow-none): the #NMDevice - * @specific_object: (allow-none): the device specific object (currently - * used only for activating WiFi devices - should be the #NMAccessPoint's - * path or WiMAX devices - use #NMWimaxNsp's path). + * @specific_object: (allow-none): the object path of a connection-type-specific + * object this activation should use. This parameter is currently ignored for + * wired and mobile broadband connections, and the value of NULL should be used + * (ie, no specific object). For WiFi or WiMAX connections, pass the object + * path of a #NMAccessPoint or #NMWimaxNsp owned by @device, which you can + * get using nm_object_get_path(), and which will be used to complete the + * details of the newly added connection. * @callback: (scope async) (allow-none): the function to call when the call is done * @user_data: (closure): user data to pass to the callback function * @@ -728,8 +732,9 @@ add_activate_cb (DBusGProxy *proxy, * @specific_object: (allow-none): the object path of a connection-type-specific * object this activation should use. This parameter is currently ignored for * wired and mobile broadband connections, and the value of NULL should be used - * (ie, no specific object). For WiFi connections, pass the object path of a - * specific AP from the card's scan list, which will be used to complete the + * (ie, no specific object). For WiFi or WiMAX connections, pass the object + * path of a #NMAccessPoint or #NMWimaxNsp owned by @device, which you can + * get using nm_object_get_path(), and which will be used to complete the * details of the newly added connection. * @callback: (scope async) (allow-none): the function to call when the call is done * @user_data: (closure): user data to pass to the callback function