system/NetworkManager
system/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager synced 2024-07-23 19:24:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: add units to some libnm (and libnm-glib) function docs

Browse source 
https://mail.gnome.org/archives/networkmanager-list/2018-May/msg00027.html
This commit is contained in:
Harry Mallon 2018-05-22 17:52:36 +01:00 committed by Thomas Haller
parent 6c2eb953d5
commit 5f62b126d5
5 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
libnm-glib/nm-access-point.c
View file

@ -166,9 +166,9 @@ nm_access_point_get_ssid (NMAccessPoint *ap)
* nm_access_point_get_frequency:
* @ap: a #NMAccessPoint
*
* Gets the frequency of the access point.
* Gets the frequency of the access point in MHz.
*
* Returns: the frequency
* Returns: the frequency in MHz
**/
guint32
nm_access_point_get_frequency (NMAccessPoint *ap)
@ -252,9 +252,9 @@ nm_access_point_get_max_bitrate (NMAccessPoint *ap)
* nm_access_point_get_strength:
* @ap: a #NMAccessPoint
*
* Gets the current signal strength of the access point.
* Gets the current signal strength of the access point as a percentage.
*
* Returns: the signal strength
* Returns: the signal strength (0 to 100)
**/
guint8
nm_access_point_get_strength (NMAccessPoint *ap)

4
libnm-glib/nm-device-ethernet.c
View file

@ -137,9 +137,9 @@ nm_device_ethernet_get_permanent_hw_address (NMDeviceEthernet *device)
* nm_device_ethernet_get_speed:
* @device: a #NMDeviceEthernet
*
* Gets the speed of the #NMDeviceEthernet.
* Gets the speed of the #NMDeviceEthernet in Mbit/s.
*
* Returns: the speed of the device
* Returns: the speed of the device in Mbit/s
**/
guint32
nm_device_ethernet_get_speed (NMDeviceEthernet *device)

2
libnm-glib/nm-device.c
View file

@ -2099,7 +2099,7 @@ nm_device_get_physical_port_id (NMDevice *device)
*
* Gets the MTU of the #NMDevice.
*
* Returns: the MTU of the device.
* Returns: the MTU of the device in bytes.
*
* Since: 0.9.10
**/

8
libnm/nm-access-point.c
View file

@ -144,9 +144,9 @@ nm_access_point_get_ssid (NMAccessPoint *ap)
* nm_access_point_get_frequency:
* @ap: a #NMAccessPoint
*
* Gets the frequency of the access point.
* Gets the frequency of the access point in MHz.
*
* Returns: the frequency
* Returns: the frequency in MHz
**/
guint32
nm_access_point_get_frequency (NMAccessPoint *ap)
@ -209,9 +209,9 @@ nm_access_point_get_max_bitrate (NMAccessPoint *ap)
* nm_access_point_get_strength:
* @ap: a #NMAccessPoint
*
* Gets the current signal strength of the access point.
* Gets the current signal strength of the access point as a percentage.
*
* Returns: the signal strength
* Returns: the signal strength (0 to 100)
**/
guint8
nm_access_point_get_strength (NMAccessPoint *ap)

4
libnm/nm-device-ethernet.c
View file

@ -92,9 +92,9 @@ nm_device_ethernet_get_permanent_hw_address (NMDeviceEthernet *device)
* nm_device_ethernet_get_speed:
* @device: a #NMDeviceEthernet
*
* Gets the speed of the #NMDeviceEthernet.
* Gets the speed of the #NMDeviceEthernet in Mbit/s.
*
* Returns: the speed of the device
* Returns: the speed of the device in Mbit/s
**/
guint32
nm_device_ethernet_get_speed (NMDeviceEthernet *device)