luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-23 20:46:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

GVariant: convert docs to markdown

Browse Source 
Convert lists to markdown syntax, and remove a lot of <literal>.
This commit is contained in:
Matthias Clasen 2014-02-01 00:26:58 -05:00
parent bc982223eb
commit fe9e812d7f
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
glib/gvariant.c
View File

@ -1001,21 +1001,18 @@ g_variant_lookup (GVariant *dictionary,
*
* Looks up a value in a dictionary #GVariant.
*
* This function works with dictionaries of the type
* <literal>a{s*}</literal> (and equally well with type
* <literal>a{o*}</literal>, but we only further discuss the string case
* This function works with dictionaries of the type a{s*} (and equally
* well with type a{o*}, but we only further discuss the string case
* for sake of clarity).
*
* In the event that @dictionary has the type <literal>a{sv}</literal>,
* the @expected_type string specifies what type of value is expected to
* be inside of the variant. If the value inside the variant has a
* different type then %NULL is returned. In the event that @dictionary
* has a value type other than <literal>v</literal> then @expected_type
* must directly match the key type and it is used to unpack the value
* directly or an error occurs.
* In the event that @dictionary has the type a{sv}, the @expected_type
* string specifies what type of value is expected to be inside of the
* variant. If the value inside the variant has a different type then
* %NULL is returned. In the event that @dictionary has a value type other
* than v then @expected_type must directly match the key type and it is
* used to unpack the value directly or an error occurs.
*
* In either case, if @key is not found in @dictionary, %NULL is
* returned.
* In either case, if @key is not found in @dictionary, %NULL is returned.
*
* If the key is found and the value has the correct type, it is
* returned. If @expected_type was specified then any non-%NULL return