Adds a comment to _cbor_builder_append mentioning its invariant

PJK · Dec 3, 2022 · ff66e8c · ff66e8c
1 parent 2ab0d05
commit ff66e8c
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/cbor/internal/builder_callbacks.c b/src/cbor/internal/builder_callbacks.c
@@ -17,6 +17,8 @@
 #include "../tags.h"
 #include "unicode.h"
 
+// This function maintains the invariant that no memory reachable by ctx->stack
+// and item would be leaked.
 void _cbor_builder_append(cbor_item_t *item,
                           struct _cbor_decoder_context *ctx) {
   if (ctx->stack->size == 0) {