LineageOS/android_external_json-c
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #153 from LeSpocky/doc

Browse Source 
improve doc for json_object_to_json_string()
This commit is contained in:
Eric Haszlakiewicz
2014-09-13 22:18:51 -04:00
parent 6ec6fdaf8c 37f5d8696d
commit ec4879ac5b
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
json_object.h
View File

@@ -161,12 +161,17 @@ extern enum json_type json_object_get_type(struct json_object *obj);
/** Stringify object to json format. /** Stringify object to json format.
* Equivalent to json_object_to_json_string_ext(obj, JSON_C_TO_STRING_SPACED) * 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 * @param obj the json_object instance
* @returns a string in JSON format * @returns a string in JSON format
*/ */
extern const char* json_object_to_json_string(struct json_object *obj); extern const char* json_object_to_json_string(struct json_object *obj);
/** Stringify object to json format /** 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 obj the json_object instance
* @param flags formatting options, see JSON_C_TO_STRING_PRETTY and other constants * @param flags formatting options, see JSON_C_TO_STRING_PRETTY and other constants
* @returns a string in JSON format * @returns a string in JSON format