[glib] GVariant: convert docs to markdown



commit fe9e812d7f606fd8df6809ab01e45addaffa1e66
Author: Matthias Clasen <mclasen redhat com>
Date:   Sat Feb 1 00:26:58 2014 -0500

    GVariant: convert docs to markdown
    
    Convert lists to markdown syntax, and remove a lot of <literal>.

 glib/gvariant.c |   21 +++++++++------------
 1 files changed, 9 insertions(+), 12 deletions(-)
---
diff --git a/glib/gvariant.c b/glib/gvariant.c
index 69f4f5f..59b92dd 100644
--- a/glib/gvariant.c
+++ b/glib/gvariant.c
@@ -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


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]