Merge pull request #444 from Hawk777/document-ref-count-tokener

Document refcount of json_tokener_parse_ex return
This commit is contained in:
Eric Haszlakiewicz
2018-08-31 01:16:53 -04:00
committed by GitHub

View File

@@ -155,9 +155,10 @@ JSON_EXPORT void json_tokener_set_flags(struct json_tokener *tok, int flags);
* called.
*
* When a valid JSON value is parsed, a non-NULL json_object will be
* returned. Also, json_tokener_get_error() will return json_tokener_success.
* Be sure to check the type with json_object_is_type() or
* json_object_get_type() before using the object.
* returned, with a reference count of one which belongs to the caller. Also,
* json_tokener_get_error() will return json_tokener_success. Be sure to check
* the type with json_object_is_type() or json_object_get_type() before using
* the object.
*
* @b XXX this shouldn't use internal fields:
* Trailing characters after the parsed value do not automatically cause an