summaryrefslogtreecommitdiff
path: root/libnm-glib/nm-access-point.c
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 /libnm-glib/nm-access-point.c
parent6c2eb953d50d1255d0b55197f711b2094e98b79a (diff)
downloadNetworkManager-5f62b126d526425f721d63f5c74f4db43a9b38f0.tar.gz
doc: add units to some libnm (and libnm-glib) function docs
https://mail.gnome.org/archives/networkmanager-list/2018-May/msg00027.html
Diffstat (limited to 'libnm-glib/nm-access-point.c')
-rw-r--r--libnm-glib/nm-access-point.c8
1 files changed, 4 insertions, 4 deletions
diff --git a/libnm-glib/nm-access-point.c b/libnm-glib/nm-access-point.c
index 88cb375fab..592818fadc 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)