From fc66e8514626522e06548c20703eca2b01f9cfbc Mon Sep 17 00:00:00 2001 From: Alberto Ruiz Date: Thu, 12 Jan 2012 17:19:28 +0000 Subject: [PATCH] docs: Update NMAccessPoint documentation Further explanation on how to get the connection list to filter against an access point. Also noting that filtering by device is recommended. --- libnm-glib/nm-access-point.c | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/libnm-glib/nm-access-point.c b/libnm-glib/nm-access-point.c index 415700d97..97464c4a2 100644 --- a/libnm-glib/nm-access-point.c +++ b/libnm-glib/nm-access-point.c @@ -368,6 +368,11 @@ nm_access_point_get_strength (NMAccessPoint *ap) * @ap's SSID, (if given) BSSID, and other attributes like security settings, * channel, band, etc. * + * To obtain the list of connections that are compatible with this access point, + * use nm_remote_settings_list_connections() and then filter the returned list + * for a given #NMDevice using nm_device_filter_connections() and finally + * filter that list with this function. + * * Returns: %TRUE if the connection may be activated with this WiFi AP, * %FALSE if it cannot be. **/