Skip to content

Commit 1cc264a

Browse files
elie-elkhourythiagomacieira
authored andcommitted
Update cborencoder.c documentation
Fixed the error checking example proposed in the comments/documentation at the beginning of the file. Changed occurrences of `if(!err)` to `if(err)`, and `cbor_assert(err)` to `cbor_assert(!err)`. Signed-off-by: Elie El Khoury <[email protected]>
1 parent d2dd95c commit 1cc264a

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/cborencoder.c

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -117,16 +117,16 @@
117117
* CborEncoder encoder, mapEncoder;
118118
* cbor_encoder_init(&encoder, buf, sizeof(buf), 0);
119119
* err = cbor_encoder_create_map(&encoder, &mapEncoder, 1);
120-
* if (!err)
120+
* if (err)
121121
* return err;
122122
* err = cbor_encode_text_stringz(&mapEncoder, "foo");
123-
* if (!err)
123+
* if (err)
124124
* return err;
125125
* err = cbor_encode_boolean(&mapEncoder, some_value);
126-
* if (!err)
126+
* if (err)
127127
* return err;
128128
* err = cbor_encoder_close_container_checked(&encoder, &mapEncoder);
129-
* if (!err)
129+
* if (err)
130130
* return err;
131131
*
132132
* size_t len = cbor_encoder_get_buffer_size(&encoder, buf);
@@ -157,7 +157,7 @@
157157
*
158158
* cbor_encoder_init(&encoder, buf, size, 0);
159159
* err = cbor_encoder_create_array(&encoder, &arrayEncoder, n);
160-
* cbor_assert(err); // can't fail, the buffer is always big enough
160+
* cbor_assert(!err); // can't fail, the buffer is always big enough
161161
*
162162
* for (i = 0; i < n; ++i) {
163163
* err = cbor_encode_text_stringz(&arrayEncoder, strings[i]);
@@ -166,7 +166,7 @@
166166
* }
167167
*
168168
* err = cbor_encoder_close_container_checked(&encoder, &arrayEncoder);
169-
* cbor_assert(err); // shouldn't fail!
169+
* cbor_assert(!err); // shouldn't fail!
170170
*
171171
* more_bytes = cbor_encoder_get_extra_bytes_needed(encoder);
172172
* if (more_size) {

0 commit comments

Comments
 (0)