Clarify header comments

This commit is contained in:
2025-08-04 12:44:00 -04:00
parent 7801dbe6d7
commit 39fe9be4dc

View File

@@ -8,14 +8,15 @@ extern "C" {
struct WeaselJsonCallbacks { struct WeaselJsonCallbacks {
void (*on_begin_object)(void *userdata); void (*on_begin_object)(void *userdata);
void (*on_end_object)(void *userdata); void (*on_end_object)(void *userdata);
/** The string data provided has already been unescaped. If `done` is false, /** The string data provided has already been unescaped, unless the
* this string may be incomplete and there will be another call with more data * WeaselJsonRaw flag is used. If `done` is false, this string may be
* incomplete and there will be another call, potentially with more data
*/ */
void (*on_string_data)(void *userdata, const char *buf, int len, int done); void (*on_string_data)(void *userdata, const char *buf, int len, int done);
void (*on_begin_array)(void *userdata); void (*on_begin_array)(void *userdata);
void (*on_end_array)(void *userdata); void (*on_end_array)(void *userdata);
/*If `done` is false, this number may be incomplete and there will be another /*If `done` is false, this number may be incomplete and there will be another
* call with more data*/ * call, potentially with more data*/
void (*on_number_data)(void *userdata, const char *buf, int len, int done); void (*on_number_data)(void *userdata, const char *buf, int len, int done);
void (*on_true_literal)(void *userdata); void (*on_true_literal)(void *userdata);
void (*on_false_literal)(void *userdata); void (*on_false_literal)(void *userdata);