summaryrefslogtreecommitdiff
path: root/libnm-glib
diff options
context:
space:
mode:
authorDan Winship <danw@gnome.org>2014-06-04 17:25:52 -0400
committerDan Winship <danw@gnome.org>2014-06-19 17:45:01 -0400
commit8487a4490c96a71cf1ee590b80716c5868233f64 (patch)
tree1f51b2bf25092653d84811e7d15f5e5162b7d2b3 /libnm-glib
parent7475d8c28d43bc85231f89d0537fafe6f8c3dcaf (diff)
downloadNetworkManager-8487a4490c96a71cf1ee590b80716c5868233f64.tar.gz
libnm-util, libnm-glib: be consistent about "Wi-Fi", "Ethernet", "InfiniBand" in docs
We made the UIs consistent last year, but missed the documentation. Fix the docs to also consistently use "Wi-Fi" rather than "WiFi", "Wifi", "wifi", or "WiFI"; "Ethernet" rather than "ethernet"; and "InfiniBand" rather than "Infiniband".
Diffstat (limited to 'libnm-glib')
-rw-r--r--libnm-glib/nm-access-point.c6
-rw-r--r--libnm-glib/nm-client.c6
-rw-r--r--libnm-glib/nm-client.h6
-rw-r--r--libnm-glib/nm-device-ethernet.c2
-rw-r--r--libnm-glib/nm-device-ethernet.h4
-rw-r--r--libnm-glib/nm-device-wifi.c12
-rw-r--r--libnm-glib/nm-device.c18
-rw-r--r--libnm-glib/nm-secret-agent.h2
8 files changed, 28 insertions, 28 deletions
diff --git a/libnm-glib/nm-access-point.c b/libnm-glib/nm-access-point.c
index 8668f2ff3d..ca3f1bf2d9 100644
--- a/libnm-glib/nm-access-point.c
+++ b/libnm-glib/nm-access-point.c
@@ -184,7 +184,7 @@ nm_access_point_get_frequency (NMAccessPoint *ap)
* nm_access_point_get_bssid:
* @ap: a #NMAccessPoint
*
- * Gets the Basic Service Set ID (BSSID) of the WiFi access point.
+ * Gets the Basic Service Set ID (BSSID) of the Wi-Fi access point.
*
* Returns: the BSSID of the access point. This is an internal string and must
* not be modified or freed.
@@ -271,12 +271,12 @@ nm_access_point_get_strength (NMAccessPoint *ap)
* @ap: an #NMAccessPoint to validate @connection against
* @connection: an #NMConnection to validate against @ap
*
- * Validates a given connection against a given WiFi access point to ensure that
+ * Validates a given connection against a given Wi-Fi access point to ensure that
* the connection may be activated with that AP. The connection must match the
* @ap's SSID, (if given) BSSID, and other attributes like security settings,
* channel, band, etc.
*
- * Returns: %TRUE if the connection may be activated with this WiFi AP,
+ * Returns: %TRUE if the connection may be activated with this Wi-Fi AP,
* %FALSE if it cannot be.
**/
gboolean
diff --git a/libnm-glib/nm-client.c b/libnm-glib/nm-client.c
index f1f6916b61..379c787909 100644
--- a/libnm-glib/nm-client.c
+++ b/libnm-glib/nm-client.c
@@ -590,7 +590,7 @@ activate_nm_not_running (gpointer user_data)
* @specific_object: (allow-none): the object path of a connection-type-specific
* object this activation should use. This parameter is currently ignored for
* wired and mobile broadband connections, and the value of %NULL should be used
- * (ie, no specific object). For WiFi or WiMAX connections, pass the object
+ * (ie, no specific object). For Wi-Fi or WiMAX connections, pass the object
* path of a #NMAccessPoint or #NMWimaxNsp owned by @device, which you can
* get using nm_object_get_path(), and which will be used to complete the
* details of the newly added connection.
@@ -600,7 +600,7 @@ activate_nm_not_running (gpointer user_data)
* Starts a connection to a particular network using the configuration settings
* from @connection and the network device @device. Certain connection types
* also take a "specific object" which is the object path of a connection-
- * specific object, like an #NMAccessPoint for WiFi connections, or an
+ * specific object, like an #NMAccessPoint for Wi-Fi connections, or an
* #NMWimaxNsp for WiMAX connections, to which you wish to connect. If the
* specific object is not given, NetworkManager can, in some cases, automatically
* determine which network to connect to given the settings in @connection.
@@ -680,7 +680,7 @@ add_activate_cb (DBusGProxy *proxy,
* @specific_object: (allow-none): the object path of a connection-type-specific
* object this activation should use. This parameter is currently ignored for
* wired and mobile broadband connections, and the value of %NULL should be used
- * (ie, no specific object). For WiFi or WiMAX connections, pass the object
+ * (ie, no specific object). For Wi-Fi or WiMAX connections, pass the object
* path of a #NMAccessPoint or #NMWimaxNsp owned by @device, which you can
* get using nm_object_get_path(), and which will be used to complete the
* details of the newly added connection.
diff --git a/libnm-glib/nm-client.h b/libnm-glib/nm-client.h
index a563f0bf43..1baabecce8 100644
--- a/libnm-glib/nm-client.h
+++ b/libnm-glib/nm-client.h
@@ -65,7 +65,7 @@ G_BEGIN_DECLS
* @NM_CLIENT_PERMISSION_NONE: unknown or no permission
* @NM_CLIENT_PERMISSION_ENABLE_DISABLE_NETWORK: controls whether networking
* can be globally enabled or disabled
- * @NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI: controls whether WiFi can be
+ * @NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI: controls whether Wi-Fi can be
* globally enabled or disabled
* @NM_CLIENT_PERMISSION_ENABLE_DISABLE_WWAN: controls whether WWAN (3G) can be
* globally enabled or disabled
@@ -76,8 +76,8 @@ G_BEGIN_DECLS
* @NM_CLIENT_PERMISSION_NETWORK_CONTROL: controls whether networking connections
* can be started, stopped, and changed
* @NM_CLIENT_PERMISSION_WIFI_SHARE_PROTECTED: controls whether a password
- * protected WiFi hotspot can be created
- * @NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN: controls whether an open WiFi hotspot
+ * protected Wi-Fi hotspot can be created
+ * @NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN: controls whether an open Wi-Fi hotspot
* can be created
* @NM_CLIENT_PERMISSION_SETTINGS_MODIFY_SYSTEM: controls whether connections
* that are available to all users can be modified
diff --git a/libnm-glib/nm-device-ethernet.c b/libnm-glib/nm-device-ethernet.c
index efdb3228c2..8f3171154e 100644
--- a/libnm-glib/nm-device-ethernet.c
+++ b/libnm-glib/nm-device-ethernet.c
@@ -194,7 +194,7 @@ connection_compatible (NMDevice *device, NMConnection *connection, GError **erro
/* Wired setting optional for PPPoE */
if (!is_pppoe && !s_wired) {
g_set_error (error, NM_DEVICE_ETHERNET_ERROR, NM_DEVICE_ETHERNET_ERROR_INVALID_ETHERNET_CONNECTION,
- "The connection was not a valid ethernet connection.");
+ "The connection was not a valid Ethernet connection.");
return FALSE;
}
diff --git a/libnm-glib/nm-device-ethernet.h b/libnm-glib/nm-device-ethernet.h
index 4028d62ca4..a68a97ecc8 100644
--- a/libnm-glib/nm-device-ethernet.h
+++ b/libnm-glib/nm-device-ethernet.h
@@ -38,8 +38,8 @@ G_BEGIN_DECLS
/**
* NMDeviceEthernetError:
* @NM_DEVICE_ETHERNET_ERROR_UNKNOWN: unknown or unclassified error
- * @NM_DEVICE_ETHERNET_ERROR_NOT_ETHERNET_CONNECTION: the connection was not of ethernet or PPPoE type
- * @NM_DEVICE_ETHERNET_ERROR_INVALID_ETHERNET_CONNECTION: the ethernet connection was invalid
+ * @NM_DEVICE_ETHERNET_ERROR_NOT_ETHERNET_CONNECTION: the connection was not of Ethernet or PPPoE type
+ * @NM_DEVICE_ETHERNET_ERROR_INVALID_ETHERNET_CONNECTION: the Ethernet connection was invalid
* @NM_DEVICE_ETHERNET_ERROR_INVALID_DEVICE_MAC: the device's MAC was invalid
* @NM_DEVICE_ETHERNET_ERROR_MAC_MISMATCH: the MACs of the connection and the device mismatched
*/
diff --git a/libnm-glib/nm-device-wifi.c b/libnm-glib/nm-device-wifi.c
index 2436b90bbf..b9cc31d8f3 100644
--- a/libnm-glib/nm-device-wifi.c
+++ b/libnm-glib/nm-device-wifi.c
@@ -110,7 +110,7 @@ nm_device_wifi_error_quark (void)
*
* Creates a new #NMDeviceWifi.
*
- * Returns: (transfer full): a new WiFi device
+ * Returns: (transfer full): a new Wi-Fi device
**/
GObject *
nm_device_wifi_new (DBusGConnection *connection, const char *path)
@@ -216,7 +216,7 @@ nm_device_wifi_get_bitrate (NMDeviceWifi *device)
* nm_device_wifi_get_capabilities:
* @device: a #NMDeviceWifi
*
- * Gets the WIFI capabilities of the #NMDeviceWifi.
+ * Gets the Wi-Fi capabilities of the #NMDeviceWifi.
*
* Returns: the capabilities
**/
@@ -813,10 +813,10 @@ nm_device_wifi_class_init (NMDeviceWifiClass *wifi_class)
/**
* NMDeviceWifi::access-point-added:
- * @device: the wifi device that received the signal
+ * @device: the Wi-Fi device that received the signal
* @ap: the new access point
*
- * Notifies that a #NMAccessPoint is added to the wifi device.
+ * Notifies that a #NMAccessPoint is added to the Wi-Fi device.
**/
signals[ACCESS_POINT_ADDED] =
g_signal_new ("access-point-added",
@@ -830,10 +830,10 @@ nm_device_wifi_class_init (NMDeviceWifiClass *wifi_class)
/**
* NMDeviceWifi::access-point-removed:
- * @device: the wifi device that received the signal
+ * @device: the Wi-Fi device that received the signal
* @ap: the removed access point
*
- * Notifies that a #NMAccessPoint is removed from the wifi device.
+ * Notifies that a #NMAccessPoint is removed from the Wi-Fi device.
**/
signals[ACCESS_POINT_REMOVED] =
g_signal_new ("access-point-removed",
diff --git a/libnm-glib/nm-device.c b/libnm-glib/nm-device.c
index 2d48265514..b328ba3bbc 100644
--- a/libnm-glib/nm-device.c
+++ b/libnm-glib/nm-device.c
@@ -581,7 +581,7 @@ nm_device_class_init (NMDeviceClass *device_class)
(object_class, PROP_DEVICE_TYPE,
g_param_spec_uint (NM_DEVICE_DEVICE_TYPE,
"Device Type",
- "Numeric device type (ie ethernet, wifi, etc)",
+ "Numeric device type (ie Ethernet, Wi-Fi, etc)",
NM_DEVICE_TYPE_UNKNOWN, G_MAXUINT32, NM_DEVICE_TYPE_UNKNOWN,
G_PARAM_READABLE));
/**
@@ -1059,7 +1059,7 @@ nm_device_get_ip_iface (NMDevice *device)
* nm_device_get_device_type:
* @device: a #NMDevice
*
- * Returns the numeric type of the #NMDevice, ie ethernet, wifi, etc.
+ * Returns the numeric type of the #NMDevice, ie Ethernet, Wi-Fi, etc.
*
* Returns: the device type
**/
@@ -2158,8 +2158,8 @@ nm_device_disconnect (NMDevice *device,
*
* Validates a given connection for a given #NMDevice object and returns
* whether the connection may be activated with the device. For example if
- * @device is a WiFi device that supports only WEP encryption, the connection
- * will only be valid if it is a WiFi connection which describes a WEP or open
+ * @device is a Wi-Fi device that supports only WEP encryption, the connection
+ * will only be valid if it is a Wi-Fi connection which describes a WEP or open
* network, and will not be valid if it describes a WPA network, or if it is
* an Ethernet, Bluetooth, WWAN, etc connection that is incompatible with the
* device.
@@ -2201,8 +2201,8 @@ connection_compatible (NMDevice *device, NMConnection *connection, GError **erro
*
* Validates a given connection for a given #NMDevice object and returns
* whether the connection may be activated with the device. For example if
- * @device is a WiFi device that supports only WEP encryption, the connection
- * will only be valid if it is a WiFi connection which describes a WEP or open
+ * @device is a Wi-Fi device that supports only WEP encryption, the connection
+ * will only be valid if it is a Wi-Fi connection which describes a WEP or open
* network, and will not be valid if it describes a WPA network, or if it is
* an Ethernet, Bluetooth, WWAN, etc connection that is incompatible with the
* device.
@@ -2231,10 +2231,10 @@ nm_device_connection_compatible (NMDevice *device, NMConnection *connection, GEr
*
* Filters a given list of connections for a given #NMDevice object and return
* connections which may be activated with the device. For example if @device
- * is a WiFi device that supports only WEP encryption, the returned list will
- * contain any WiFi connections in @connections that allow connection to
+ * is a Wi-Fi device that supports only WEP encryption, the returned list will
+ * contain any Wi-Fi connections in @connections that allow connection to
* unencrypted or WEP-enabled SSIDs. The returned list will not contain
- * Ethernet, Bluetooth, WiFi WPA connections, or any other connection that is
+ * Ethernet, Bluetooth, Wi-Fi WPA connections, or any other connection that is
* incompatible with the device. To get the full list of connections see
* nm_remote_settings_list_connections().
*
diff --git a/libnm-glib/nm-secret-agent.h b/libnm-glib/nm-secret-agent.h
index 9a6103f53f..c70f8d0762 100644
--- a/libnm-glib/nm-secret-agent.h
+++ b/libnm-glib/nm-secret-agent.h
@@ -141,7 +141,7 @@ typedef struct {
* return them, or to return an error, this function should be called with
* those secrets or the error.
*
- * To easily create the hash table to return the WiFi PSK, you could do
+ * To easily create the hash table to return the Wi-Fi PSK, you could do
* something like this:
* <example>
* <title>Creating a secrets hash</title>