summaryrefslogtreecommitdiff
path: root/json-glib/json-gvariant.c
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2014-03-06 13:58:15 +0000
committerEmmanuele Bassi <ebassi@gnome.org>2014-03-18 16:27:59 +0000
commit20c861f02f8e41cde2dec92f9d63d8266383c26b (patch)
treeb5a9fa61922cbc27cc0c94e52979d96df11a4a8d /json-glib/json-gvariant.c
parentff018d7e560278d65a03c4de71c3cf11b22d3167 (diff)
downloadjson-glib-20c861f02f8e41cde2dec92f9d63d8266383c26b.tar.gz
docs: Port to MarkDown
Drop the DocBook documentation, and move everything to the MarkDown format used by modern gtk-doc.
Diffstat (limited to 'json-glib/json-gvariant.c')
-rw-r--r--json-glib/json-gvariant.c64
1 files changed, 22 insertions, 42 deletions
diff --git a/json-glib/json-gvariant.c b/json-glib/json-gvariant.c
index 41b6f43..99e6d64 100644
--- a/json-glib/json-gvariant.c
+++ b/json-glib/json-gvariant.c
@@ -51,49 +51,29 @@
* JSON, a #GVariant type string (signature) should be provided to these
* methods in order to obtain a correct, type-contrained result.
* If no signature is provided, conversion can still be done, but the
- * resulting #GVariant value will be "guessed" from the JSON data types,
- * according to the following table:
+ * resulting #GVariant value will be "guessed" from the JSON data types
+ * using the following rules:
*
- * <table frame='all'><title>Default JSON to GVariant conversion (without signature constrains)</title>
- * <tgroup cols='2' align='left' colsep='1' rowsep='1'>
- * <thead>
- * <row>
- * <entry>JSON</entry>
- * <entry>GVariant</entry>
- * </row>
- * </thead>
- * <tfoot>
- * <row>
- * <entry>string</entry>
- * <entry>string (s)</entry>
- * </row>
- * <row>
- * <entry>int64</entry>
- * <entry>int64 (x)</entry>
- * </row>
- * <row>
- * <entry>boolean</entry>
- * <entry>boolean (b)</entry>
- * </row>
- * <row>
- * <entry>double</entry>
- * <entry>double (d)</entry>
- * </row>
- * <row>
- * <entry>array</entry>
- * <entry>array of variants (av)</entry>
- * </row>
- * <row>
- * <entry>object</entry>
- * <entry>dictionary of string-variant (a{sv})</entry>
- * </row>
- * <row>
- * <entry>null</entry>
- * <entry>maybe variant (mv)</entry>
- * </row>
- * </tfoot>
- * </tgroup>
- * </table>
+ * ## Strings
+ * JSON strings map to GVariant `(s)`.
+ *
+ * ## Integers
+ * JSON integers map to GVariant int64 `(x)`.
+ *
+ * ## Booleans
+ * JSON booleans map to GVariant boolean `(b)`.
+ *
+ * ## Numbers
+ * JSON numbers map to GVariant double `(d)`.
+ *
+ * ## Arrays
+ * JSON arrays map to GVariant arrays of variants `(av)`.
+ *
+ * ## Objects
+ * JSON objects map to GVariant dictionaries of string to variants `(a{sv})`.
+ *
+ * ## Null values
+ * JSON null values map to GVariant maybe variants `(mv)`.
*/
/* custom extension to the GVariantClass enumeration to differentiate