fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-02-05 04:10:28 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

libnm-util: fix some GObject Introspection annotations

Browse source 
Unfortunately, GObject Introspection can no longer describe deeper
types, like those inside nested hash tables, which NM uses extensively
for the NMConnection type and other places.  So we have to remove
those descriptions.  But this moves us back into compliance with
GOI annotation formats.
This commit is contained in:
Dan Williams 2011-05-10 13:24:07 -05:00
parent ab56b8e925
commit 9ff4914ccc
2 changed files with 18 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
libnm-util/nm-connection.c
View file

@ -512,7 +512,7 @@ validate_permissions_type (GHashTable *hash, GError **error)
/**
* nm_connection_replace_settings:
* @connection: a #NMConnection
* @new_settings: (element-type utf8 GHashTable<utf8,GValue>): a #GHashTable of settings
* @new_settings: (element-type utf8 GLib.HashTable): a #GHashTable of settings
* @error: location to store error, or %NULL
*
* Returns: %TRUE if the settings were valid and added to the connection, %FALSE
@ -640,9 +640,10 @@ diff_one_connection (NMConnection *a,
* @a: a #NMConnection
* @b: a second #NMConnection to compare with the first
* @flags: compare flags, e.g. %NM_SETTING_COMPARE_FLAG_EXACT
* @out_settings: (element-type utf8 GHashTable<utf8,guint32>): if the
* @out_settings: (element-type utf8 GLib.HashTable): if the
* connections differ, on return a hash table mapping setting names to
* second-level GHashTable, which contains key names that differ
* second-level GHashTable (utf8 to guint32), which contains the key names that
* differ mapped to one or more of %NMSettingDiffResult as a bitfield
*
* Compares two #NMConnection objects for similarity, with comparison behavior
* modified by a set of flags. See nm_setting_compare() for a description of
@ -968,7 +969,7 @@ nm_connection_clear_secrets (NMConnection *connection)
* are #GHashTables mapping string:GValue, each of which represents the
* properties of the #NMSetting object.
*
* Returns: (transfer full) (element-type utf8 GHashTable<utf8,GValue>): a new
* Returns: (transfer full) (element-type utf8 GLib.HashTable): a new
* #GHashTable describing the connection, its settings, and each setting's
* properties. The caller owns the hash table and must unref the hash table
* with g_hash_table_unref() when it is no longer needed.

25
libnm-util/nm-setting.c
View file

@ -112,9 +112,10 @@ destroy_gvalue (gpointer data)
*
* Converts the #NMSetting into a #GHashTable mapping each setting property
* name to a GValue describing that property, suitable for marshalling over
* D-Bus or serializing. The mapping is string:GValue.
* D-Bus or serializing. The mapping is string to GValue.
*
* Returns: (transfer full) (element-type utf8 GObject.Value): a new #GHashTable describing the setting's properties
* Returns: (transfer full) (element-type utf8 GObject.Value): a new #GHashTable
* describing the setting's properties
**/
GHashTable *
nm_setting_to_hash (NMSetting *setting, NMSettingHashFlags flags)
@ -209,8 +210,8 @@ one_property_cb (gpointer key, gpointer val, gpointer user_data)
/**
* nm_setting_new_from_hash:
* @setting_type: the #NMSetting type which the hash contains properties for
* @hash: the #GHashTable containing a string:GValue mapping of properties
* that apply to the setting
* @hash: (element-type utf8 GObject.Value): the #GHashTable containing a
* string to GValue mapping of properties that apply to the setting
*
* Creates a new #NMSetting object and populates that object with the properties
* contained in the hash table, using each hash key as the property to set,
@ -223,8 +224,7 @@ one_property_cb (gpointer key, gpointer val, gpointer user_data)
* hash table, or NULL on failure
**/
NMSetting *
nm_setting_new_from_hash (GType setting_type,
GHashTable *hash)
nm_setting_new_from_hash (GType setting_type, GHashTable *hash)
{
NMSetting *setting;
NMSettingFromHashInfo info;
@ -421,10 +421,11 @@ nm_setting_compare (NMSetting *a,
* @flags: compare flags, e.g. %NM_SETTING_COMPARE_FLAG_EXACT
* @invert_results: this parameter is used internally by libnm-util and should
* be set to %FALSE. If %TRUE inverts the meaning of the #NMSettingDiffResult.
* @results: (element-type utf8 guint32): if the settings differ, on return a
* hash table mapping the differing keys to one or more #NMSettingDiffResult
* values OR-ed together. If the settings do not differ, any hash table passed
* in is unmodified. If no hash table is passed in, a new one is created.
* @results: (inout) (transfer full) (element-type utf8 guint32): if the
* settings differ, on return a hash table mapping the differing keys to one or
* more %NMSettingDiffResult values OR-ed together. If the settings do not
* differ, any hash table passed in is unmodified. If no hash table is passed
* in and the settings differ, a new one is created and returned.
*
* Compares two #NMSetting objects for similarity, with comparison behavior
* modified by a set of flags. See the documentation for #NMSettingCompareFlags
@ -661,8 +662,8 @@ update_one_secret (NMSetting *setting, const char *key, GValue *value, GError **
/**
* nm_setting_update_secrets:
* @setting: the #NMSetting
* @secrets: a #GHashTable mapping string:#GValue of setting property names and
* secrets
* @secrets: (element-type utf8 GObject.Value): a #GHashTable mapping
* string to #GValue of setting property names and secrets
* @error: location to store error, or %NULL
*
* Update the setting's secrets, given a hash table of secrets intended for that