summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDan Winship <danw@gnome.org>2014-07-07 14:09:04 -0400
committerDan Winship <danw@gnome.org>2014-07-15 09:44:54 -0400
commit4223fa47e477ba89d4e4c223f8bedd55dec0a6f6 (patch)
tree49b5a032540b81467196f2773ad584694c55e331
parent7eb0288aa0c62f9feb2f2ad456ebde083f7284aa (diff)
downloadNetworkManager-4223fa47e477ba89d4e4c223f8bedd55dec0a6f6.tar.gz
libnm-util, libnm-glib: tweak (element-type) annotations in docs
g-i allows you to specify types in annotations using either their fully-qualified introspected names (eg, "NMClient.Device") or their plain C names ("NMDevice"). Switch from the former to the latter (so that they'll still be correct when migrated to libnm later).
-rw-r--r--libnm-glib/nm-access-point.c4
-rw-r--r--libnm-glib/nm-active-connection.c2
-rw-r--r--libnm-glib/nm-client.c10
-rw-r--r--libnm-glib/nm-device-bond.c2
-rw-r--r--libnm-glib/nm-device-bridge.c2
-rw-r--r--libnm-glib/nm-device-team.c2
-rw-r--r--libnm-glib/nm-device-wifi.c2
-rw-r--r--libnm-glib/nm-device-wimax.c2
-rw-r--r--libnm-glib/nm-device.c6
-rw-r--r--libnm-glib/nm-ip4-config.c4
-rw-r--r--libnm-glib/nm-ip6-config.c4
-rw-r--r--libnm-glib/nm-remote-settings.c2
-rw-r--r--libnm-glib/nm-wimax-nsp.c4
-rw-r--r--libnm-util/nm-utils.c8
14 files changed, 27 insertions, 27 deletions
diff --git a/libnm-glib/nm-access-point.c b/libnm-glib/nm-access-point.c
index 5e3b8b2a0f..284e562dcd 100644
--- a/libnm-glib/nm-access-point.c
+++ b/libnm-glib/nm-access-point.c
@@ -377,7 +377,7 @@ nm_access_point_connection_valid (NMAccessPoint *ap, NMConnection *connection)
/**
* nm_access_point_filter_connections:
* @ap: an #NMAccessPoint to filter connections for
- * @connections: (element-type NetworkManager.Connection): a list of
+ * @connections: (element-type NMConnection): a list of
* #NMConnection objects to filter
*
* Filters a given list of connections for a given #NMAccessPoint object and
@@ -390,7 +390,7 @@ nm_access_point_connection_valid (NMAccessPoint *ap, NMConnection *connection)
* for a given #NMDevice using nm_device_filter_connections() and finally
* filter that list with this function.
*
- * Returns: (transfer container) (element-type NetworkManager.Connection): a
+ * Returns: (transfer container) (element-type NMConnection): a
* list of #NMConnection objects that could be activated with the given @ap.
* The elements of the list are owned by their creator and should not be freed
* by the caller, but the returned list itself is owned by the caller and should
diff --git a/libnm-glib/nm-active-connection.c b/libnm-glib/nm-active-connection.c
index 6ffe54f696..5e7315639b 100644
--- a/libnm-glib/nm-active-connection.c
+++ b/libnm-glib/nm-active-connection.c
@@ -308,7 +308,7 @@ nm_active_connection_get_specific_object (NMActiveConnection *connection)
*
* Gets the #NMDevices used for the active connections.
*
- * Returns: (element-type NMClient.Device): the #GPtrArray containing #NMDevices.
+ * Returns: (element-type NMDevice): the #GPtrArray containing #NMDevices.
* This is the internal copy used by the connection, and must not be modified.
**/
const GPtrArray *
diff --git a/libnm-glib/nm-client.c b/libnm-glib/nm-client.c
index 2bc19f473c..c56eea2522 100644
--- a/libnm-glib/nm-client.c
+++ b/libnm-glib/nm-client.c
@@ -364,7 +364,7 @@ client_recheck_permissions (DBusGProxy *proxy, gpointer user_data)
* 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
+ * Returns: (transfer none) (element-type NMDevice): a #GPtrArray
* containing all the #NMDevices. The returned array is owned by the
* #NMClient object and should not be modified.
**/
@@ -783,7 +783,7 @@ nm_client_deactivate_connection (NMClient *client, NMActiveConnection *active)
*
* Gets the active connections.
*
- * Returns: (transfer none) (element-type NMClient.ActiveConnection): a #GPtrArray
+ * Returns: (transfer none) (element-type NMActiveConnection): a #GPtrArray
* containing all the active #NMActiveConnections.
* The returned array is owned by the client and should not be modified.
**/
@@ -2304,7 +2304,7 @@ nm_client_class_init (NMClientClass *client_class)
* NMClient::active-connections:
*
* The active connections.
- * Type: GPtrArray<NMClient.ActiveConnection>
+ * Type: GPtrArray<NMActiveConnection>
**/
g_object_class_install_property
(object_class, PROP_ACTIVE_CONNECTIONS,
@@ -2376,7 +2376,7 @@ nm_client_class_init (NMClientClass *client_class)
/**
* NMClient::device-added:
* @client: the client that received the signal
- * @device: (type NMClient.Device): the new device
+ * @device: (type NMDevice): the new device
*
* Notifies that a #NMDevice is added.
**/
@@ -2392,7 +2392,7 @@ nm_client_class_init (NMClientClass *client_class)
/**
* NMClient::device-removed:
* @client: the client that received the signal
- * @device: (type NMClient.Device): the removed device
+ * @device: (type NMDevice): the removed device
*
* Notifies that a #NMDevice is removed.
**/
diff --git a/libnm-glib/nm-device-bond.c b/libnm-glib/nm-device-bond.c
index 0895132862..bf4d08a4e5 100644
--- a/libnm-glib/nm-device-bond.c
+++ b/libnm-glib/nm-device-bond.c
@@ -139,7 +139,7 @@ nm_device_bond_get_carrier (NMDeviceBond *device)
*
* Gets the devices currently slaved to @device.
*
- * Returns: (element-type NMClient.Device): the #GPtrArray containing
+ * Returns: (element-type NMDevice): the #GPtrArray containing
* #NMDevices that are slaves of @device. This is the internal
* copy used by the device, and must not be modified.
*
diff --git a/libnm-glib/nm-device-bridge.c b/libnm-glib/nm-device-bridge.c
index 76a4e359fe..50ce7a819f 100644
--- a/libnm-glib/nm-device-bridge.c
+++ b/libnm-glib/nm-device-bridge.c
@@ -147,7 +147,7 @@ nm_device_bridge_get_carrier (NMDeviceBridge *device)
*
* Gets the devices currently slaved to @device.
*
- * Returns: (element-type NMClient.Device): the #GPtrArray containing
+ * Returns: (element-type NMDevice): the #GPtrArray containing
* #NMDevices that are slaves of @device. This is the internal
* copy used by the device, and must not be modified.
*
diff --git a/libnm-glib/nm-device-team.c b/libnm-glib/nm-device-team.c
index 4b14971ba6..3b7c0064e7 100644
--- a/libnm-glib/nm-device-team.c
+++ b/libnm-glib/nm-device-team.c
@@ -145,7 +145,7 @@ nm_device_team_get_carrier (NMDeviceTeam *device)
*
* Gets the devices currently enslaved to @device.
*
- * Returns: (element-type NMClient.Device): the #GPtrArray containing
+ * Returns: (element-type NMDevice): the #GPtrArray containing
* #NMDevices that are slaves of @device. This is the internal
* copy used by the device, and must not be modified.
*
diff --git a/libnm-glib/nm-device-wifi.c b/libnm-glib/nm-device-wifi.c
index 85ead2c33c..79812f75e9 100644
--- a/libnm-glib/nm-device-wifi.c
+++ b/libnm-glib/nm-device-wifi.c
@@ -270,7 +270,7 @@ nm_device_wifi_get_active_access_point (NMDeviceWifi *device)
*
* Gets all the scanned access points of the #NMDeviceWifi.
*
- * Returns: (element-type NMClient.AccessPoint): a #GPtrArray containing all the
+ * Returns: (element-type NMAccessPoint): a #GPtrArray containing all the
* scanned #NMAccessPoints.
* The returned array is owned by the client and should not be modified.
**/
diff --git a/libnm-glib/nm-device-wimax.c b/libnm-glib/nm-device-wimax.c
index 30fc69adcd..e30d409325 100644
--- a/libnm-glib/nm-device-wimax.c
+++ b/libnm-glib/nm-device-wimax.c
@@ -180,7 +180,7 @@ nm_device_wimax_get_active_nsp (NMDeviceWimax *wimax)
*
* Gets all the scanned NSPs of the #NMDeviceWimax.
*
- * Returns: (element-type NMClient.WimaxNsp): a #GPtrArray containing
+ * Returns: (element-type NMWimaxNsp): a #GPtrArray containing
* all the scanned #NMWimaxNsps.
* The returned array is owned by the client and should not be modified.
**/
diff --git a/libnm-glib/nm-device.c b/libnm-glib/nm-device.c
index de4193df5f..284e41cc23 100644
--- a/libnm-glib/nm-device.c
+++ b/libnm-glib/nm-device.c
@@ -1425,7 +1425,7 @@ nm_device_get_active_connection (NMDevice *device)
* Gets the #NMRemoteConnections currently known to the daemon that could
* be activated on @device.
*
- * Returns: (element-type NMClient.RemoteConnection): the #GPtrArray
+ * Returns: (element-type NMRemoteConnection): the #GPtrArray
* containing #NMRemoteConnections. This is the internal copy used by
* the connection, and must not be modified.
*
@@ -2204,7 +2204,7 @@ nm_device_connection_compatible (NMDevice *device, NMConnection *connection, GEr
/**
* nm_device_filter_connections:
* @device: an #NMDevice to filter connections for
- * @connections: (element-type NetworkManager.Connection): a list of #NMConnection objects to filter
+ * @connections: (element-type NMConnection): a list of #NMConnection objects to filter
*
* 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
@@ -2215,7 +2215,7 @@ nm_device_connection_compatible (NMDevice *device, NMConnection *connection, GEr
* incompatible with the device. To get the full list of connections see
* nm_remote_settings_list_connections().
*
- * Returns: (transfer container) (element-type NetworkManager.Connection): a
+ * Returns: (transfer container) (element-type NMConnection): a
* list of #NMConnection objects that could be activated with the given @device.
* The elements of the list are owned by their creator and should not be freed
* by the caller, but the returned list itself is owned by the caller and should
diff --git a/libnm-glib/nm-ip4-config.c b/libnm-glib/nm-ip4-config.c
index 88c4cfbd01..206b815c86 100644
--- a/libnm-glib/nm-ip4-config.c
+++ b/libnm-glib/nm-ip4-config.c
@@ -361,7 +361,7 @@ nm_ip4_config_get_gateway (NMIP4Config *config)
*
* Gets the IP4 addresses (containing the address, prefix, and gateway).
*
- * Returns: (element-type NetworkManager.IP4Address): the #GSList containing #NMIP4Address<!-- -->es.
+ * Returns: (element-type NMIP4Address): the #GSList containing #NMIP4Address<!-- -->es.
* This is the internal copy used by the configuration and must not be modified.
**/
const GSList *
@@ -455,7 +455,7 @@ nm_ip4_config_get_wins_servers (NMIP4Config *config)
*
* Gets the routes.
*
- * Returns: (element-type NetworkManager.IP4Route): the #GSList containing
+ * Returns: (element-type NMIP4Route): the #GSList containing
* #NMIP4Routes. This is the internal copy used by the configuration,
* and must not be modified.
**/
diff --git a/libnm-glib/nm-ip6-config.c b/libnm-glib/nm-ip6-config.c
index 985b61b4cc..69d9bc9b32 100644
--- a/libnm-glib/nm-ip6-config.c
+++ b/libnm-glib/nm-ip6-config.c
@@ -179,7 +179,7 @@ nm_ip6_config_get_gateway (NMIP6Config *config)
*
* Gets the IP6 addresses (containing the address, prefix, and gateway).
*
- * Returns: (element-type NetworkManager.IP6Address): the #GSList containing
+ * Returns: (element-type NMIP6Address): the #GSList containing
* #NMIP6Address<!-- -->es. This is the internal copy used by the configuration
* and must not be modified.
**/
@@ -306,7 +306,7 @@ nm_ip6_config_get_searches (NMIP6Config *config)
*
* Gets the routes.
*
- * Returns: (element-type NetworkManager.IP6Route): the #GSList containing
+ * Returns: (element-type NMIP6Route): the #GSList containing
* #NMIP6Routes. This is the internal copy used by the configuration,
* and must not be modified.
**/
diff --git a/libnm-glib/nm-remote-settings.c b/libnm-glib/nm-remote-settings.c
index c36a92c856..042ccc9b5e 100644
--- a/libnm-glib/nm-remote-settings.c
+++ b/libnm-glib/nm-remote-settings.c
@@ -597,7 +597,7 @@ fetch_connections_done (DBusGProxy *proxy,
* nm_remote_settings_list_connections:
* @settings: the %NMRemoteSettings
*
- * Returns: (transfer container) (element-type NMClient.RemoteConnection): a
+ * Returns: (transfer container) (element-type NMRemoteConnection): a
* list containing all connections provided by the remote settings service.
* Each element of the returned list is a %NMRemoteConnection instance, which is
* owned by the %NMRemoteSettings object and should not be freed by the caller.
diff --git a/libnm-glib/nm-wimax-nsp.c b/libnm-glib/nm-wimax-nsp.c
index 24f5d3ea61..81fb4b7a2d 100644
--- a/libnm-glib/nm-wimax-nsp.c
+++ b/libnm-glib/nm-wimax-nsp.c
@@ -173,14 +173,14 @@ nm_wimax_nsp_connection_valid (NMWimaxNsp *nsp, NMConnection *connection)
/**
* nm_wimax_nsp_filter_connections:
* @nsp: an #NMWimaxNsp to filter connections for
- * @connections: (element-type NetworkManager.Connection): a list of
+ * @connections: (element-type NMConnection): a list of
* #NMConnection objects to filter
*
* Filters a given list of connections for a given #NMWimaxNsp object and
* return connections which may be activated with the access point. Any
* returned connections will match the @nsp's network name and other attributes.
*
- * Returns: (transfer container) (element-type NetworkManager.Connection): a
+ * Returns: (transfer container) (element-type NMConnection): a
* list of #NMConnection objects that could be activated with the given @nsp.
* The elements of the list are owned by their creator and should not be freed
* by the caller, but the returned list itself is owned by the caller and should
diff --git a/libnm-util/nm-utils.c b/libnm-util/nm-utils.c
index 87286bda8e..2c95ae2d6b 100644
--- a/libnm-util/nm-utils.c
+++ b/libnm-util/nm-utils.c
@@ -894,7 +894,7 @@ nm_utils_wpa_psk_valid (const char *psk)
* this serialization is not guaranteed to be stable and the #GArray may be
* extended in the future.
*
- * Returns: (transfer full) (element-type NetworkManager.IP4Address): a newly allocated #GSList of #NMIP4Address objects
+ * Returns: (transfer full) (element-type NMIP4Address): a newly allocated #GSList of #NMIP4Address objects
**/
GSList *
nm_utils_ip4_addresses_from_gvalue (const GValue *value)
@@ -976,7 +976,7 @@ nm_utils_ip4_addresses_to_gvalue (GSList *list, GValue *value)
* format of this serialization is not guaranteed to be stable and may be
* extended in the future.
*
- * Returns: (transfer full) (element-type NetworkManager.IP4Route): a newly allocated #GSList of #NMIP4Route objects
+ * Returns: (transfer full) (element-type NMIP4Route): a newly allocated #GSList of #NMIP4Route objects
**/
GSList *
nm_utils_ip4_routes_from_gvalue (const GValue *value)
@@ -1133,7 +1133,7 @@ nm_utils_ip4_get_default_prefix (guint32 ip)
* this serialization is not guaranteed to be stable and the #GValueArray may be
* extended in the future.
*
- * Returns: (transfer full) (element-type NetworkManager.IP6Address): a newly allocated #GSList of #NMIP6Address objects
+ * Returns: (transfer full) (element-type NMIP6Address): a newly allocated #GSList of #NMIP6Address objects
**/
GSList *
nm_utils_ip6_addresses_from_gvalue (const GValue *value)
@@ -1270,7 +1270,7 @@ nm_utils_ip6_addresses_to_gvalue (GSList *list, GValue *value)
* into a #GSList of #NMIP6Route objects. The specific format of this serialization
* is not guaranteed to be stable and may be extended in the future.
*
- * Returns: (transfer full) (element-type NetworkManager.IP6Route): a newly allocated #GSList of #NMIP6Route objects
+ * Returns: (transfer full) (element-type NMIP6Route): a newly allocated #GSList of #NMIP6Route objects
**/
GSList *
nm_utils_ip6_routes_from_gvalue (const GValue *value)