colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libnm/connection: Add missing annotations to nm_connection_diff

Browse Source 
Allows to use this function in GObject introspected languages.

Also workaround a current issue with the gtk-doc parser not taking nested
element-type into account.
This commit is contained in:
Corentin Noël
2023-02-22 23:27:33 +01:00
committed by Thomas Haller
parent 169f8748ba
commit e0b2123c2c
1 changed files with 29 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
src/libnm-core-impl/nm-connection.c
View File

@@ -759,15 +759,18 @@ diff_one_connection(NMConnection *a,
return diff_found; return diff_found;
} }
/* Required until https://gitlab.gnome.org/GNOME/gtk-doc/-/merge_requests/71 */
#ifndef __GTK_DOC_IGNORE__
/** /**
* nm_connection_diff: * nm_connection_diff:
* @a: a #NMConnection * @a: a #NMConnection
* @b: a second #NMConnection to compare with the first * @b: a second #NMConnection to compare with the first
* @flags: compare flags, e.g. %NM_SETTING_COMPARE_FLAG_EXACT * @flags: compare flags, e.g. %NM_SETTING_COMPARE_FLAG_EXACT
* @out_settings: (element-type utf8 GLib.HashTable): if the * @out_settings: (out) (element-type utf8 GLib.HashTable<utf8,uint32>)
* connections differ, on return a hash table mapping setting names to * (optional) (allow-none): if the connections differ, on return a hash table
* second-level GHashTable (utf8 to guint32), which contains the key names that * mapping setting names to second-level GHashTable (utf8 to guint32), which
* differ mapped to one or more of %NMSettingDiffResult as a bitfield * 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 * Compares two #NMConnection objects for similarity, with comparison behavior
* modified by a set of flags. See nm_setting_compare() for a description of * modified by a set of flags. See nm_setting_compare() for a description of
@@ -778,6 +781,28 @@ diff_one_connection(NMConnection *a,
* Returns: %TRUE if the connections contain the same values, %FALSE if they do * Returns: %TRUE if the connections contain the same values, %FALSE if they do
* not * not
**/ **/
#else
/**
* nm_connection_diff:
* @a: a #NMConnection
* @b: a second #NMConnection to compare with the first
* @flags: compare flags, e.g. %NM_SETTING_COMPARE_FLAG_EXACT
* @out_settings: (out) (element-type utf8 GLib.HashTable&lt;utf8,uint32&gt;)
* (optional) (nullable): if the connections differ, on return a hash table
* mapping setting names to 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
* each flag's behavior. If the connections differ, settings and keys within
* each setting that differ are added to the returned @out_settings hash table.
* No values are returned, only key names.
*
* Returns: %TRUE if the connections contain the same values, %FALSE if they do
* not
**/
#endif
gboolean gboolean
nm_connection_diff(NMConnection *a, nm_connection_diff(NMConnection *a,
NMConnection *b, NMConnection *b,