94
94
*
95
95
* The code above does not execute a range-check either: it is possible that
96
96
* the value decoded from the CBOR stream encodes a number larger than what can
97
- * be represented in a variable of type \c{ int} . If detecting that case is
97
+ * be represented in a variable of type \c int. If detecting that case is
98
98
* important, the code should call cbor_value_get_int_checked() instead.
99
99
*
100
100
* <h3 class="groupheader">Memory and parsing constraints</h3>
134
134
*
135
135
* \if privatedocs
136
136
* Implementation details: the CborValue contains these fields:
137
- * \list
138
- * \li ptr: pointer to the actual data
139
- * \li flags: flags from the decoder
140
- * \li extra: partially decoded integer value (0, 1 or 2 bytes)
141
- * \li remaining: remaining items in this collection after this item or UINT32_MAX if length is unknown
142
- * \endlist
137
+ * - ptr: pointer to the actual data
138
+ * - flags: flags from the decoder
139
+ * - extra: partially decoded integer value (0, 1 or 2 bytes)
140
+ * - remaining: remaining items in this collection after this item or UINT32_MAX if length is unknown
143
141
* \endif
144
142
*/
145
143
@@ -429,12 +427,10 @@ CborError cbor_value_reparse(CborValue *it)
429
427
* will appear during parsing.
430
428
*
431
429
* A basic validation checks for:
432
- * \list
433
- * \li absence of undefined additional information bytes;
434
- * \li well-formedness of all numbers, lengths, and simple values;
435
- * \li string contents match reported sizes;
436
- * \li arrays and maps contain the number of elements they are reported to have;
437
- * \endlist
430
+ * - absence of undefined additional information bytes;
431
+ * - well-formedness of all numbers, lengths, and simple values;
432
+ * - string contents match reported sizes;
433
+ * - arrays and maps contain the number of elements they are reported to have;
438
434
*
439
435
* For further checks, see cbor_value_validate().
440
436
*
@@ -745,7 +741,7 @@ CborError cbor_value_leave_container(CborValue *it, const CborValue *recursed)
745
741
* \ref cbor_value_is_integer is recommended.
746
742
*
747
743
* Note that this function does not do range-checking: integral values that do
748
- * not fit in a variable of type \c{ int} are silently truncated to fit. Use
744
+ * not fit in a variable of type \c int are silently truncated to fit. Use
749
745
* cbor_value_get_int_checked() if that is not acceptable.
750
746
*
751
747
* \sa cbor_value_get_type(), cbor_value_is_valid(), cbor_value_is_integer()
@@ -760,7 +756,7 @@ CborError cbor_value_leave_container(CborValue *it, const CborValue *recursed)
760
756
* \ref cbor_value_is_integer is recommended.
761
757
*
762
758
* Note that this function does not do range-checking: integral values that do
763
- * not fit in a variable of type \c{ int64_t} are silently truncated to fit. Use
759
+ * not fit in a variable of type \c int64_t are silently truncated to fit. Use
764
760
* cbor_value_get_int64_checked() that is not acceptable.
765
761
*
766
762
* \sa cbor_value_get_type(), cbor_value_is_valid(), cbor_value_is_integer()
@@ -791,7 +787,7 @@ CborError cbor_value_leave_container(CborValue *it, const CborValue *recursed)
791
787
* If the integer is unsigned (that is, if cbor_value_is_unsigned_integer()
792
788
* returns true), then \a result will contain the actual value. If the integer
793
789
* is negative, then \a result will contain the absolute value of that integer,
794
- * minus one. That is, \c { actual = -result - 1} . On architectures using two's
790
+ * minus one. That is, <tt> actual = -result - 1</tt> . On architectures using two's
795
791
* complement for representation of negative integers, it is equivalent to say
796
792
* that \a result will contain the bitwise negation of the actual value.
797
793
*
@@ -1244,10 +1240,10 @@ static CborError iterate_string_chunks(const CborValue *value, char *buffer, siz
1244
1240
* of the string in order to preallocate a buffer, use
1245
1241
* cbor_value_calculate_string_length().
1246
1242
*
1247
- * On success, this function sets the number of bytes copied to \c{ *buflen} . If
1243
+ * On success, this function sets the number of bytes copied to \c *buflen. If
1248
1244
* the buffer is large enough, this function will insert a null byte after the
1249
1245
* last copied byte, to facilitate manipulation of text strings. That byte is
1250
- * not included in the returned value of \c{ *buflen} . If there was no space for
1246
+ * not included in the returned value of \c *buflen. If there was no space for
1251
1247
* the terminating null, no error is returned, so callers must check the value
1252
1248
* of *buflen after the call, before relying on the '\0'; if it has not been
1253
1249
* changed by the call, there is no '\0'-termination on the buffer's contents.
@@ -1281,10 +1277,10 @@ static CborError iterate_string_chunks(const CborValue *value, char *buffer, siz
1281
1277
* of the string in order to preallocate a buffer, use
1282
1278
* cbor_value_calculate_string_length().
1283
1279
*
1284
- * On success, this function sets the number of bytes copied to \c{ *buflen} . If
1280
+ * On success, this function sets the number of bytes copied to \c *buflen. If
1285
1281
* the buffer is large enough, this function will insert a null byte after the
1286
1282
* last copied byte, to facilitate manipulation of null-terminated strings.
1287
- * That byte is not included in the returned value of \c{ *buflen} .
1283
+ * That byte is not included in the returned value of \c *buflen.
1288
1284
*
1289
1285
* The \a next pointer, if not null, will be updated to point to the next item
1290
1286
* after this string. If \a value points to the last item, then \a next will be
@@ -1521,7 +1517,7 @@ CborError cbor_value_map_find_value(const CborValue *map, const char *string, Cb
1521
1517
* cbor_value_is_half_float is recommended.
1522
1518
*
1523
1519
* Note: since the C language does not have a standard type for half-precision
1524
- * floating point, this function takes a \c{ void *} as a parameter for the
1520
+ * floating point, this function takes a <tt> void *</tt> as a parameter for the
1525
1521
* storage area, which must be at least 16 bits wide.
1526
1522
*
1527
1523
* \sa cbor_value_get_type(), cbor_value_is_valid(), cbor_value_is_half_float(), cbor_value_get_half_float_as_float(), cbor_value_get_float()
0 commit comments