summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHarry Mallon <hjmallon@gmail.com>2018-05-22 17:52:36 +0100
committerThomas Haller <thaller@redhat.com>2018-05-23 16:17:03 +0200
commit5f62b126d526425f721d63f5c74f4db43a9b38f0 (patch)
tree6de2f5d88df64ced4eadb6d3e73e301aed9e17ec
parent6c2eb953d50d1255d0b55197f711b2094e98b79a (diff)
doc: add units to some libnm (and libnm-glib) function docs
https://mail.gnome.org/archives/networkmanager-list/2018-May/msg00027.html
-rw-r--r--libnm-glib/nm-access-point.c8
-rw-r--r--libnm-glib/nm-device-ethernet.c4
-rw-r--r--libnm-glib/nm-device.c2
-rw-r--r--libnm/nm-access-point.c8
-rw-r--r--libnm/nm-device-ethernet.c4
5 files changed, 13 insertions, 13 deletions
diff --git a/libnm-glib/nm-access-point.c b/libnm-glib/nm-access-point.c
index 88cb375fa..592818fad 100644
--- a/libnm-glib/nm-access-point.c
+++ b/libnm-glib/nm-access-point.c
@@ -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)
diff --git a/libnm-glib/nm-device-ethernet.c b/libnm-glib/nm-device-ethernet.c
index 2817a3205..df677b292 100644
--- a/libnm-glib/nm-device-ethernet.c
+++ b/libnm-glib/nm-device-ethernet.c
@@ -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)
diff --git a/libnm-glib/nm-device.c b/libnm-glib/nm-device.c
index d6b3c398d..6179b7578 100644
--- a/libnm-glib/nm-device.c
+++ b/libnm-glib/nm-device.c
@@ -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
**/
diff --git a/libnm/nm-access-point.c b/libnm/nm-access-point.c
index ba5bcb830..75ea55705 100644
--- a/libnm/nm-access-point.c
+++ b/libnm/nm-access-point.c
@@ -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)
diff --git a/libnm/nm-device-ethernet.c b/libnm/nm-device-ethernet.c
index 727ea8a64..ebb019dcf 100644
--- a/libnm/nm-device-ethernet.c
+++ b/libnm/nm-device-ethernet.c
@@ -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)