Commit 468a0193 authored by Corentin Noël's avatar Corentin Noël Committed by Thomas Haller

gobject-introspection: made several fixes to the annotations

https://bugzilla.gnome.org/show_bug.cgi?id=794658
parent 03a9bb88
......@@ -977,13 +977,11 @@ nm_setting_bond_class_init (NMSettingBondClass *setting_class)
/* Properties */
/**
* NMSettingBond:options:
* NMSettingBond:options: (type GHashTable(utf8,utf8))
*
* Dictionary of key/value pairs of bonding options. Both keys and values
* must be strings. Option names must contain only alphanumeric characters
* (ie, [a-zA-Z0-9]).
*
* Type: GHashTable(utf8,utf8)
**/
/* ---ifcfg-rh---
* property: options
......
......@@ -1099,13 +1099,11 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
G_PARAM_STATIC_STRINGS));
/**
* NMSettingDcb:priority-flow-control:
* NMSettingDcb:priority-flow-control: (type GArray(gboolean))
*
* An array of 8 boolean values, where the array index corresponds to the User
* Priority (0 - 7) and the value indicates whether or not the corresponding
* priority should transmit priority pause.
*
* Element-type: gboolean
**/
/* ---ifcfg-rh---
* property: priority-flow-control
......@@ -1149,13 +1147,11 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
G_PARAM_STATIC_STRINGS));
/**
* NMSettingDcb:priority-group-id:
* NMSettingDcb:priority-group-id: (type GArray(guint))
*
* An array of 8 uint values, where the array index corresponds to the User
* Priority (0 - 7) and the value indicates the Priority Group ID. Allowed
* Priority Group ID values are 0 - 7 or 15 for the unrestricted group.
*
* Element-type: guint
**/
/* ---ifcfg-rh---
* property: priority-group-id
......@@ -1177,14 +1173,12 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
_nm_setting_dcb_uint_array_from_dbus);
/**
* NMSettingDcb:priority-group-bandwidth:
* NMSettingDcb:priority-group-bandwidth: (type GArray(guint))
*
* An array of 8 uint values, where the array index corresponds to the
* Priority Group ID (0 - 7) and the value indicates the percentage of link
* bandwidth allocated to that group. Allowed values are 0 - 100, and the
* sum of all values must total 100 percents.
*
* Element-type: guint
**/
/* ---ifcfg-rh---
* property: priority-group-bandwidth
......@@ -1205,15 +1199,13 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
_nm_setting_dcb_uint_array_from_dbus);
/**
* NMSettingDcb:priority-bandwidth:
* NMSettingDcb:priority-bandwidth: (type GArray(guint))
*
* An array of 8 uint values, where the array index corresponds to the User
* Priority (0 - 7) and the value indicates the percentage of bandwidth of
* the priority's assigned group that the priority may use. The sum of all
* percentages for priorities which belong to the same group must total 100
* percents.
*
* Element-type: guint
**/
/* ---ifcfg-rh---
* property: priority-bandwidth
......@@ -1235,13 +1227,11 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
_nm_setting_dcb_uint_array_from_dbus);
/**
* NMSettingDcb:priority-strict-bandwidth:
* NMSettingDcb:priority-strict-bandwidth: (type GArray(gboolean))
*
* An array of 8 boolean values, where the array index corresponds to the User
* Priority (0 - 7) and the value indicates whether or not the priority may
* use all of the bandwidth allocated to its assigned group.
*
* Element-type: gboolean
**/
/* ---ifcfg-rh---
* property: priority-strict-bandwidth
......@@ -1263,13 +1253,11 @@ nm_setting_dcb_class_init (NMSettingDcbClass *setting_class)
_nm_setting_dcb_uint_array_from_dbus);
/**
* NMSettingDcb:priority-traffic-class:
* NMSettingDcb:priority-traffic-class: (type GArray(guint))
*
* An array of 8 uint values, where the array index corresponds to the User
* Priority (0 - 7) and the value indicates the traffic class (0 - 7) to
* which the priority is mapped.
*
* Element-type: guint
**/
/* ---ifcfg-rh---
* property: priority-traffic-class
......
......@@ -2993,11 +2993,9 @@ nm_setting_ip_config_class_init (NMSettingIPConfigClass *setting_class)
G_PARAM_STATIC_STRINGS));
/**
* NMSettingIPConfig:addresses:
* NMSettingIPConfig:addresses: (type GPtrArray(NMIPAddress))
*
* Array of IP addresses.
*
* Element-Type: NMIPAddress
**/
g_object_class_install_property
(object_class, PROP_ADDRESSES,
......@@ -3034,11 +3032,9 @@ nm_setting_ip_config_class_init (NMSettingIPConfigClass *setting_class)
NULL);
/**
* NMSettingIPConfig:routes:
* NMSettingIPConfig:routes: (type GPtrArray(NMIPRoute))
*
* Array of IP routes.
*
* Element-Type: NMIPRoute
**/
g_object_class_install_property
(object_class, PROP_ROUTES,
......
......@@ -1507,11 +1507,9 @@ nm_setting_tc_config_class_init (NMSettingTCConfigClass *setting_class)
/* Properties */
/**
* NMSettingTCConfig:qdiscs:
* NMSettingTCConfig:qdiscs: (type GPtrArray(NMTCQdisc))
*
* Array of TC queuening disciplines.
*
* Element-Type: NMTCQdisc
**/
/* ---ifcfg-rh---
* property: qdiscs
......@@ -1536,11 +1534,9 @@ nm_setting_tc_config_class_init (NMSettingTCConfigClass *setting_class)
NULL);
/**
* NMSettingTCConfig:tfilters:
* NMSettingTCConfig:tfilters: (type GPtrArray(NMTCTfilter))
*
* Array of TC traffic filters.
*
* Element-Type: NMTCTfilter
**/
/* ---ifcfg-rh---
* property: qdiscs
......
......@@ -696,7 +696,7 @@ nm_setting_team_port_class_init (NMSettingTeamPortClass *setting_class)
G_PARAM_STATIC_STRINGS));
/**
* NMSettingTeamPort:link-watchers:
* NMSettingTeamPort:link-watchers: (type GPtrArray(NMTeamLinkWatcher))
*
* Link watchers configuration for the connection: each link watcher is
* defined by a dictionary, whose keys depend upon the selected link
......@@ -707,7 +707,6 @@ nm_setting_team_port_class_init (NMSettingTeamPortClass *setting_class)
* arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active',
* 'validate-incative', 'send-always'. See teamd.conf man for more details.
*
* Element-Type: NMTeamLinkWatcher
* Since: 1.12
**/
g_object_class_install_property
......
......@@ -1799,7 +1799,7 @@ nm_setting_team_class_init (NMSettingTeamClass *setting_class)
G_PARAM_STATIC_STRINGS));
/**
* NMSettingTeam:link-watchers:
* NMSettingTeam:link-watchers: (type GPtrArray(NMTeamLinkWatcher))
*
* Link watchers configuration for the connection: each link watcher is
* defined by a dictionary, whose keys depend upon the selected link
......@@ -1810,7 +1810,6 @@ nm_setting_team_class_init (NMSettingTeamClass *setting_class)
* arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active',
* 'validate-incative', 'send-always'. See teamd.conf man for more details.
*
* Element-Type: NMTeamLinkWatcher
* Since: 1.12
**/
g_object_class_install_property
......
......@@ -587,14 +587,12 @@ nm_setting_user_class_init (NMSettingUserClass *klass)
setting_class->verify = verify;
/**
* NMSettingUser:data:
* NMSettingUser:data: (type GHashTable(utf8,utf8))
*
* A dictionary of key/value pairs with user data. This data is ignored by NetworkManager
* and can be used at the users discretion. The keys only support a strict ascii format,
* but the values can be arbitrary UTF8 strings up to a certain length.
*
* Type: GHashTable(utf8,utf8)
*
* Since: 1.8
**/
/* ---ifcfg-rh---
......
......@@ -945,12 +945,10 @@ nm_setting_vpn_class_init (NMSettingVpnClass *setting_class)
G_PARAM_STATIC_STRINGS));
/**
* NMSettingVpn:data:
* NMSettingVpn:data: (type GHashTable(utf8,utf8))
*
* Dictionary of key/value pairs of VPN plugin specific data. Both keys and
* values must be strings.
*
* Type: GHashTable(utf8,utf8)
**/
/* ---keyfile---
* property: data
......@@ -972,12 +970,10 @@ nm_setting_vpn_class_init (NMSettingVpnClass *setting_class)
_nm_utils_strdict_from_dbus);
/**
* NMSettingVpn:secrets:
* NMSettingVpn:secrets: (type GHashTable(utf8,utf8))
*
* Dictionary of key/value pairs of VPN plugin specific secrets like
* passwords or private keys. Both keys and values must be strings.
*
* Type: GHashTable(utf8,utf8)
**/
/* ---keyfile---
* property: secrets
......
......@@ -1363,14 +1363,12 @@ nm_setting_wired_class_init (NMSettingWiredClass *setting_wired_class)
G_PARAM_STATIC_STRINGS));
/**
* NMSettingWired:s390-options:
* NMSettingWired:s390-options: (type GHashTable(utf8,utf8))
*
* Dictionary of key/value pairs of s390-specific device options. Both keys
* and values must be strings. Allowed keys include "portno", "layer2",
* "portname", "protocol", among others. Key names must contain only
* alphanumeric characters (ie, [a-zA-Z0-9]).
*
* Type: GHashTable(utf8,utf8)
**/
/* ---ifcfg-rh---
* property: s390-options
......
......@@ -3662,7 +3662,7 @@ _nm_utils_hwaddr_aton (const char *asc, gpointer buffer, gsize buffer_length, gs
/**
* nm_utils_hwaddr_aton:
* @asc: the ASCII representation of a hardware address
* @buffer: buffer to store the result into
* @buffer: (type guint8) (array length=length): buffer to store the result into
* @length: the expected length in bytes of the result and
* the size of the buffer in bytes.
*
......@@ -3894,9 +3894,9 @@ _nm_utils_hwaddr_canonical_or_invalid (const char *mac, gssize length)
/**
* nm_utils_hwaddr_matches:
* @hwaddr1: pointer to a binary or ASCII hardware address, or %NULL
* @hwaddr1: (nullable): pointer to a binary or ASCII hardware address, or %NULL
* @hwaddr1_len: size of @hwaddr1, or -1 if @hwaddr1 is ASCII
* @hwaddr2: pointer to a binary or ASCII hardware address, or %NULL
* @hwaddr2: (nullable): pointer to a binary or ASCII hardware address, or %NULL
* @hwaddr2_len: size of @hwaddr2, or -1 if @hwaddr2 is ASCII
*
* Generalized hardware address comparison function. Tests if @hwaddr1 and
......@@ -5952,7 +5952,8 @@ attribute_unescape (const char *start, const char *end)
*
* Parse attributes from a string.
*
* Returns: (transfer full): a #GHashTable mapping attribute names to #GVariant values.
* Returns: (transfer full) (element-type utf8 GVariant): a #GHashTable mapping
* attribute names to #GVariant values.
*
* Since: 1.8
*/
......@@ -6111,7 +6112,7 @@ next:
/*
* nm_utils_format_variant_attributes:
* @attributes: a #GHashTable mapping attribute names to #GVariant values
* @attributes: (element-type utf8 GVariant): a #GHashTable mapping attribute names to #GVariant values
* @attr_separator: the attribute separator character
* @key_value_separator: character separating key and values
*
......
......@@ -34,7 +34,7 @@
G_BEGIN_DECLS
struct _NMVpnPluginInfo;
typedef struct _NMVpnPluginInfo NMVpnPluginInfo;
typedef struct _NMVpnEditorPlugin NMVpnEditorPlugin;
typedef struct _NMVpnEditor NMVpnEditor;
......@@ -128,7 +128,7 @@ typedef struct {
char * (*get_suggested_filename) (NMVpnEditorPlugin *plugin, NMConnection *connection);
void (*notify_plugin_info_set) (NMVpnEditorPlugin *plugin,
struct _NMVpnPluginInfo *plugin_info);
NMVpnPluginInfo *plugin_info);
const NMVpnEditorPluginVT *(*get_vt) (NMVpnEditorPlugin *plugin,
gsize *out_vt_size);
......@@ -171,9 +171,9 @@ NMVpnEditorPlugin *nm_vpn_editor_plugin_load (const char *plugin_name,
GError **error);
NM_AVAILABLE_IN_1_4
struct _NMVpnPluginInfo *nm_vpn_editor_plugin_get_plugin_info (NMVpnEditorPlugin *plugin);
NMVpnPluginInfo *nm_vpn_editor_plugin_get_plugin_info (NMVpnEditorPlugin *plugin);
NM_AVAILABLE_IN_1_4
void nm_vpn_editor_plugin_set_plugin_info (NMVpnEditorPlugin *plugin, struct _NMVpnPluginInfo *plugin_info);
void nm_vpn_editor_plugin_set_plugin_info (NMVpnEditorPlugin *plugin, NMVpnPluginInfo *plugin_info);
#include "nm-vpn-plugin-info.h"
......
......@@ -49,10 +49,10 @@ struct _NMVpnPluginInfo;
/**
* NMVpnPluginInfo:
*/
typedef struct _NMVpnPluginInfo {
struct _NMVpnPluginInfo {
NM_AVAILABLE_IN_1_2
GObject parent;
} NMVpnPluginInfo;
};
typedef struct {
NM_AVAILABLE_IN_1_2
......
......@@ -201,6 +201,7 @@ if enable_introspection
export_packages: libnm_name,
includes: 'Gio-2.0',
extra_args: cflags,
header: 'NetworkManager.h',
install: true
)
......
......@@ -661,11 +661,9 @@ nm_active_connection_class_init (NMActiveConnectionClass *ap_class)
G_PARAM_STATIC_STRINGS));
/**
* NMActiveConnection:devices:
* NMActiveConnection:devices: (type GPtrArray(NMDevice))
*
* The devices of the active connection.
*
* Element-type: NMDevice
**/
g_object_class_install_property
(object_class, PROP_DEVICES,
......
......@@ -176,7 +176,7 @@ nm_checkpoint_class_init (NMCheckpointClass *checkpoint_class)
nm_object_class->init_dbus = init_dbus;
/**
* NMCheckpoint:devices:
* NMCheckpoint:devices: (type GPtrArray(NMDevice))
*
* The devices that are part of this checkpoint.
*
......
......@@ -3280,11 +3280,9 @@ nm_client_class_init (NMClientClass *client_class)
G_PARAM_STATIC_STRINGS));
/**
* NMClient:active-connections:
* NMClient:active-connections: (type GPtrArray(NMActiveConnection))
*
* The active connections.
*
* Element-type: NMActiveConnection
**/
g_object_class_install_property
(object_class, PROP_ACTIVE_CONNECTIONS,
......@@ -3361,11 +3359,9 @@ nm_client_class_init (NMClientClass *client_class)
G_PARAM_STATIC_STRINGS));
/**
* NMClient:devices:
* NMClient:devices: (type GPtrArray(NMDevice))
*
* List of real network devices. Does not include placeholder devices.
*
* Element-type: NMDevice
**/
g_object_class_install_property
(object_class, PROP_DEVICES,
......@@ -3375,11 +3371,9 @@ nm_client_class_init (NMClientClass *client_class)
G_PARAM_STATIC_STRINGS));
/**
* NMClient:all-devices:
* NMClient:all-devices: (type GPtrArray(NMDevice))
*
* List of both real devices and device placeholders.
*
* Element-type: NMDevice
* Since: 1.2
**/
g_object_class_install_property
......@@ -3390,14 +3384,12 @@ nm_client_class_init (NMClientClass *client_class)
G_PARAM_STATIC_STRINGS));
/**
* NMClient:connections:
* NMClient:connections: (type GPtrArray(NMRemoteConnection))
*
* The list of configured connections that are available to the user. (Note
* that this differs from the underlying D-Bus property, which may also
* contain the object paths of connections that the user does not have
* permission to read the details of.)
*
* Element-type: NMRemoteConnection
*/
g_object_class_install_property
(object_class, PROP_CONNECTIONS,
......@@ -3474,7 +3466,7 @@ nm_client_class_init (NMClientClass *client_class)
G_PARAM_STATIC_STRINGS));
/**
* NMClient:dns-configuration:
* NMClient:dns-configuration: (type GPtrArray(GVariant))
*
* The current DNS configuration represented as an array of
* dictionaries. Each dictionary has the "nameservers",
......@@ -3494,7 +3486,7 @@ nm_client_class_init (NMClientClass *client_class)
G_PARAM_STATIC_STRINGS));
/**
* NMClient::checkpoints
* NMClient:checkpoints: (type GPtrArray(NMCheckpoint))
*
* The list of active checkpoints.
*
......
......@@ -248,11 +248,9 @@ nm_device_bond_class_init (NMDeviceBondClass *bond_class)
G_PARAM_STATIC_STRINGS));
/**
* NMDeviceBond:slaves:
* NMDeviceBond:slaves: (type GPtrArray(NMDevice))
*
* The devices slaved to the bond device.
*
* Element-type: NMDevice
**/
g_object_class_install_property
(object_class, PROP_SLAVES,
......
......@@ -253,11 +253,9 @@ nm_device_bridge_class_init (NMDeviceBridgeClass *bridge_class)
G_PARAM_STATIC_STRINGS));
/**
* NMDeviceBridge:slaves:
* NMDeviceBridge:slaves: (type GPtrArray(NMDevice))
*
* The devices slaved to the bridge device.
*
* Element-type: NMDevice
**/
g_object_class_install_property
(object_class, PROP_SLAVES,
......
......@@ -274,11 +274,9 @@ nm_device_team_class_init (NMDeviceTeamClass *team_class)
G_PARAM_STATIC_STRINGS));
/**
* NMDeviceTeam:slaves:
* NMDeviceTeam:slaves: (type GPtrArray(NMDevice))
*
* The devices enslaved to the team device.
*
* Element-type: NMDevice
**/
g_object_class_install_property
(object_class, PROP_SLAVES,
......
......@@ -887,11 +887,9 @@ nm_device_wifi_class_init (NMDeviceWifiClass *wifi_class)
G_PARAM_STATIC_STRINGS));
/**
* NMDeviceWifi:access-points:
* NMDeviceWifi:access-points: (type GPtrArray(NMAccessPoint))
*
* List of all Wi-Fi access points the device can see.
*
* Element-type: NMAccessPoint
**/
g_object_class_install_property
(object_class, PROP_ACCESS_POINTS,
......
......@@ -650,11 +650,9 @@ nm_device_wimax_class_init (NMDeviceWimaxClass *wimax_class)
G_PARAM_STATIC_STRINGS));
/**
* NMDeviceWimax:nsps:
* NMDeviceWimax:nsps: (type GPtrArray(NMWimaxNsp))
*
* List of all WiMAX Network Service Providers the device can see.
*
* Element-type: NMWimaxNsp
**/
g_object_class_install_property
(object_class, PROP_NSPS,
......
......@@ -735,11 +735,9 @@ nm_device_class_init (NMDeviceClass *device_class)
G_PARAM_STATIC_STRINGS));
/**
* NMDevice:available-connections:
* NMDevice:available-connections: (type GPtrArray(NMRemoteConnection))
*
* The available connections of the device
*
* Element-type: NMRemoteConnection
**/
g_object_class_install_property
(object_class, PROP_AVAILABLE_CONNECTIONS,
......
......@@ -154,11 +154,9 @@ nm_dhcp_config_class_init (NMDhcpConfigClass *config_class)
G_PARAM_STATIC_STRINGS));
/**
* NMDhcpConfig:options:
* NMDhcpConfig:options: (type GHashTable(utf8,utf8))
*
* The #GHashTable containing options of the configuration.
*
* Type: GLib.HashTable(utf8,utf8)
**/
g_object_class_install_property
(object_class, PROP_OPTIONS,
......
......@@ -304,7 +304,7 @@ nm_ip_config_class_init (NMIPConfigClass *config_class)
G_PARAM_STATIC_STRINGS));
/**
* NMIPConfig:routes:
* NMIPConfig:routes: (type GPtrArray(NMIPRoute))
*
* A #GPtrArray containing the routes (#NMIPRoute) of the configuration.
**/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment