Skip to content

Commit

Permalink
Document max_callback_level a bit more
Browse files Browse the repository at this point in the history
  • Loading branch information
mnunberg committed May 17, 2015
1 parent 32edbc4 commit 11f7ef4
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion jsonsl.h
Expand Up @@ -468,7 +468,12 @@ struct jsonsl_st {
/** Default callback for any action, if neither PUSH or POP callbacks are defined */
jsonsl_stack_callback action_callback;

/** Do not invoke callbacks for objects deeper than this level */
/**
* Do not invoke callbacks for objects deeper than this level.
* NOTE: This field establishes the lower bound for ignored callbacks,
* and is thus misnamed. `min_ignore_level` would actually make more
* sense, but we don't want to break API.
*/
unsigned int max_callback_level;

/** The error callback. Invoked when an error happens. Should not be NULL */
Expand Down

0 comments on commit 11f7ef4

Please sign in to comment.