fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-03-22 05:40:35 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

libnm-util, libnm-glib: tweak (element-type) annotations in docs

Browse source 
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).
This commit is contained in:
Dan Winship 2014-07-07 14:09:04 -04:00
parent 7eb0288aa0
commit 4223fa47e4
14 changed files with 27 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -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

2
libnm-glib/nm-active-connection.c
View file

@ -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 *

10
libnm-glib/nm-client.c
View file

@ -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.
**/

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

@ -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.
*

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

@ -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.
*

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

@ -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.
*

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

@ -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.
**/

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

@ -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.
**/

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

@ -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

4
libnm-glib/nm-ip4-config.c
View file

@ -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.
**/

4
libnm-glib/nm-ip6-config.c
View file

@ -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.
**/

2
libnm-glib/nm-remote-settings.c
View file

@ -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.

4
libnm-glib/nm-wimax-nsp.c
View file

@ -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

8
libnm-util/nm-utils.c
View file

@ -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)