summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCorentin Noël <corentin.noel@collabora.com>2023-03-21 11:56:10 +0100
committerThomas Haller <thaller@redhat.com>2023-03-23 17:11:52 +0100
commit1395cc09bd79601ab52e390ee4dcef7f90796bdb (patch)
tree5690fd556fc3244a01073ad65fbfeaa7de1aedc1
parent5bee60bb813f8dab5885f6f5b6704bf8cf336d0e (diff)
libnm/connection: Fix nested hashtable documentation
The GObject Introspection added support for using parenthesis in 1.39.0 https://bugzilla.gnome.org/show_bug.cgi?id=663190 Better use it to not collide with gtk-doc. Fixes: e0b2123c2c26 ('libnm/connection: Add missing annotations to nm_connection_diff') https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/1575
-rw-r--r--src/libnm-core-impl/nm-connection.c26
1 files changed, 1 insertions, 25 deletions
diff --git a/src/libnm-core-impl/nm-connection.c b/src/libnm-core-impl/nm-connection.c
index 994f08d5d2..bc16a6bb42 100644
--- a/src/libnm-core-impl/nm-connection.c
+++ b/src/libnm-core-impl/nm-connection.c
@@ -759,14 +759,12 @@ diff_one_connection(NMConnection *a,
return diff_found;
}
-/* Required until https://gitlab.gnome.org/GNOME/gtk-doc/-/merge_requests/71 */
-#ifndef __GTK_DOC_IGNORE__
/**
* 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<utf8,uint32>)
+ * @out_settings: (out) (element-type utf8 GLib.HashTable(utf8,uint32))
* (optional) (allow-none): 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
@@ -781,28 +779,6 @@ diff_one_connection(NMConnection *a,
* Returns: %TRUE if the connections contain the same values, %FALSE if they do
* 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
nm_connection_diff(NMConnection *a,
NMConnection *b,