From: Alexander Dahl <ada@ifak-system.com>
Date: Mon, 18 Aug 2014 08:28:38 +0000 (+0200)
Subject: improve doc for json_object_to_json_string()
X-Git-Tag: json-c-0.13-20171207~202^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F153%2Fhead;p=thirdparty%2Fjson-c.git

improve doc for json_object_to_json_string()
---

diff --git a/json_object.h b/json_object.h
index 200ac403..9cdb6a8c 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