diff options
author | Lloyd Hilaiel <me@lloyd.io> | 2014-03-18 22:21:09 -0700 |
---|---|---|
committer | Lloyd Hilaiel <me@lloyd.io> | 2014-03-18 22:21:09 -0700 |
commit | 12ee82ae5138ac86252c41f3ae8f9fd9880e4284 (patch) | |
tree | e5c2c00ee1c062318df1c941985cf04e34d7977c | |
parent | a908d2de55ec6163716051e62410e0549b3db089 (diff) | |
download | yajl-12ee82ae5138ac86252c41f3ae8f9fd9880e4284.tar.gz |
clarifications in yajl_gen_reset()'s documentation
-rw-r--r-- | src/api/yajl_gen.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/src/api/yajl_gen.h b/src/api/yajl_gen.h index ddd1527..a74cff1 100644 --- a/src/api/yajl_gen.h +++ b/src/api/yajl_gen.h @@ -154,8 +154,10 @@ extern "C" { * json entities in a stream. The "sep" string will be inserted to * separate the previously generated entity from the current, * NULL means *no separation* of entites (clients beware, generating - * multiple JSON numbers, for instance, will result in inscrutable - * output) */ + * multiple JSON numbers without a separator, for instance, will result in ambiguous output) + * + * Note: this call will not clear yajl's output buffer. This + * may be accomplished explicitly by calling yajl_gen_clear() */ YAJL_API void yajl_gen_reset(yajl_gen hand, const char * sep); #ifdef __cplusplus |