fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-02-05 05:20:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

libnm-glib: clarify documentation of nm_client_get_devices()

Browse source
This commit is contained in:
Colin Walters 2012-12-13 17:11:34 -06:00 • committed by Dan Williams
parent 383a397a92
commit 1b84012762
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
libnm-glib/nm-client.c
View file

@ -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)