diff options
author | Colin Walters <walters@verbum.org> | 2012-12-13 17:11:34 -0600 |
---|---|---|
committer | Dan Williams <dcbw@redhat.com> | 2012-12-13 17:12:11 -0600 |
commit | 1b840127620e27b78311032499746efe60d4fdcd (patch) | |
tree | f72823477e1f031b38cff91d89652cfce3e2a653 /libnm-glib | |
parent | 383a397a92621cdc299be561674fd3ad8b8304e5 (diff) | |
download | NetworkManager-1b840127620e27b78311032499746efe60d4fdcd.tar.gz |
libnm-glib: clarify documentation of nm_client_get_devices()
Diffstat (limited to 'libnm-glib')
-rw-r--r-- | libnm-glib/nm-client.c | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/libnm-glib/nm-client.c b/libnm-glib/nm-client.c index 178a5fdd40..4bd8956218 100644 --- a/libnm-glib/nm-client.c +++ b/libnm-glib/nm-client.c @@ -334,10 +334,14 @@ client_recheck_permissions (DBusGProxy *proxy, gpointer user_data) * nm_client_get_devices: * @client: a #NMClient * - * Gets all the detected devices. + * Gets all the known network devices. Use nm_device_get_type() or the + * NM_IS_DEVICE_XXXX() functions to determine what kind of device member of the + * returned array is, and then you may use device-specific methods such as + * nm_device_ethernet_get_hw_address(). * - * Returns: (transfer none) (element-type NMClient.Device): a #GPtrArray containing all the #NMDevice<!-- -->s. - * The returned array is owned by the client and should not be modified. + * Returns: (transfer none) (element-type NMClient.Device): a #GPtrArray + * containing all the #NMDevice<!-- -->s. The returned array is owned by the + * #NMClient object and should not be modified. **/ const GPtrArray * nm_client_get_devices (NMClient *client) |