summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexander Dahl <ada@ifak-system.com>2014-08-18 10:28:38 +0200
committerAlexander Dahl <ada@ifak-system.com>2014-08-18 10:28:38 +0200
commit37f5d8696d2c60d106dbba9fe73a5ead40b8fd19 (patch)
treed78db8e68e381f970821269674f962899dd59a2a
parentd4e81f9ec8273914739808737fa0a27a3f0589fb (diff)
improve doc for json_object_to_json_string()
-rw-r--r--json_object.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/json_object.h b/json_object.h
index 200ac40..9cdb6a8 100644
--- a/json_object.h
+++ b/json_object.h
@@ -161,12 +161,17 @@ extern enum json_type json_object_get_type(struct json_object *obj);
/** Stringify object to json format.
* Equivalent to json_object_to_json_string_ext(obj, JSON_C_TO_STRING_SPACED)
+ * The pointer you get is an internal of your json object. You don't
+ * have to free it, later use of json_object_put() should be sufficient.
+ * If you can not ensure there's no concurrent access to *obj use
+ * strdup().
* @param obj the json_object instance
* @returns a string in JSON format
*/
extern const char* json_object_to_json_string(struct json_object *obj);
/** Stringify object to json format
+ * @see json_object_to_json_string() for details on how to free string.
* @param obj the json_object instance
* @param flags formatting options, see JSON_C_TO_STRING_PRETTY and other constants
* @returns a string in JSON format