summaryrefslogtreecommitdiff
path: root/json-glib/json-object.c
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@openedhand.com>2007-10-16 16:40:57 +0100
committerEmmanuele Bassi <ebassi@openedhand.com>2007-10-16 16:40:57 +0100
commit474ecf1cc6aae35b184edffc75fc8626c3f12f61 (patch)
tree4de451ab4d5f1ef676b420b2bc587f52c1ed9226 /json-glib/json-object.c
parent93e26b94d9bb1909f3b16a4b0500f27660d7e621 (diff)
downloadjson-glib-474ecf1cc6aae35b184edffc75fc8626c3f12f61.tar.gz
Add a note in the JsonObject documentation for the member name normalization
Diffstat (limited to 'json-glib/json-object.c')
-rw-r--r--json-glib/json-object.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/json-glib/json-object.c b/json-glib/json-object.c
index d197d38..32a6a85 100644
--- a/json-glib/json-object.c
+++ b/json-glib/json-object.c
@@ -29,7 +29,11 @@
*
* #JsonArray is the representation of the object type inside JSON. It contains
* #JsonNode<!-- -->s, which may contain fundamental types, arrays or other
- * objects. Each member of an object is accessed using its name.
+ * objects. Each member of an object is accessed using its name. Please note
+ * that the member names are normalized internally before being used; every
+ * delimiter matching the %G_STR_DELIMITER macro will be transformed into an
+ * underscore, so for instance "member-name" and "member_name" are equivalent
+ * for a #JsonObject.
*
* Since objects can be expensive, they are reference counted. You can control
* the lifetime of a #JsonObject using json_object_ref() and json_object_unref().