Browse Source

Merge pull request #153 from LeSpocky/doc

improve doc for json_object_to_json_string()
tags/json-c-0.13-20171207
Eric Haszlakiewicz 11 years ago
parent
commit
ec4879ac5b
1 changed files with 5 additions and 0 deletions
  1. +5
    -0
      json_object.h

+ 5
- 0
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.
* 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


Loading…
Cancel
Save