summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJonathan Aillet <jonathan.aillet@iot.bzh>2018-07-20 12:43:19 +0200
committerRomain Forlot <romain.forlot@iot.bzh>2018-12-13 14:12:02 +0100
commit5e68dd976b6710a28955368b0b67fbbcd6cce371 (patch)
tree6bb5aac12984a50b3d33881ae49a4c627a1b820c
parentdd085dc34cddd93faa63ed49a3159c7ec0a242dd (diff)
Enhance 'wrap_json_clone_depth' description
Enhance 'wrap_json_clone_depth' description by adding details about clone depth using this function. Change-Id: Iede8fa6a697f12e8a32c1e15afdcef445edbcfe4 Signed-off-by: Jonathan Aillet <jonathan.aillet@iot.bzh>
-rw-r--r--wrap-json.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/wrap-json.c b/wrap-json.c
index 6e60476..0633991 100644
--- a/wrap-json.c
+++ b/wrap-json.c
@@ -992,9 +992,13 @@ struct json_object *wrap_json_clone_depth(struct json_object *item, int depth)
}
/**
- * Clones the 'object': returns a copy of it. But doen't clones
+ * Clones the 'object': returns a copy of it. But doesn't clones
* the content. Synonym of wrap_json_clone_depth(object, 1).
*
+ * Be aware that this implementation doesn't clones content that is deeper
+ * than 1 but it does link these contents to the original object and
+ * increments their use count. So, everything deeper that 1 is still available.
+ *
* @param object the object to clone
*
* @return a copy of the object.