]> git.ipfire.org Git - thirdparty/json-c.git/commitdiff
improve doc for json_object_to_json_string() 153/head
authorAlexander Dahl <ada@ifak-system.com>
Mon, 18 Aug 2014 08:28:38 +0000 (10:28 +0200)
committerAlexander Dahl <ada@ifak-system.com>
Mon, 18 Aug 2014 08:28:38 +0000 (10:28 +0200)
json_object.h

index 200ac4031d4707e802a92059bd21e13579983eeb..9cdb6a8c71d2de1dd4e12d282c84dfc0d4f440d7 100644 (file)
@@ -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