From 12ee82ae5138ac86252c41f3ae8f9fd9880e4284 Mon Sep 17 00:00:00 2001 From: Lloyd Hilaiel Date: Tue, 18 Mar 2014 22:21:09 -0700 Subject: [PATCH] clarifications in yajl_gen_reset()'s documentation --- src/api/yajl_gen.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/api/yajl_gen.h b/src/api/yajl_gen.h index ddd15272..a74cff1b 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