Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/cborencoder.c
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
* complete the encoding. At the end, you can obtain that count by calling
* cbor_encoder_get_extra_bytes_needed().
*
* \section1 Finalizing the encoding
* \section Finalizing the encoding
*
* Once all items have been appended and the containers have all been properly
* closed, the user-supplied buffer will contain the CBOR stream and may be
Expand Down Expand Up @@ -545,7 +545,7 @@ CborError cbor_encoder_create_array(CborEncoder *parentEncoder, CborEncoder *arr
* when creating the map, the constant \ref CborIndefiniteLength may be passed as
* length instead, and an indefinite length map is created.
*
* \b{Implementation limitation:} TinyCBOR cannot encode more than SIZE_MAX/2
* <b>Implementation limitation:</b> TinyCBOR cannot encode more than SIZE_MAX/2
* key-value pairs in the stream. If the length \a length is larger than this
* value (and is not \ref CborIndefiniteLength), this function returns error
* CborErrorDataTooLarge.
Expand Down
38 changes: 17 additions & 21 deletions src/cborparser.c
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@
*
* The code above does not execute a range-check either: it is possible that
* the value decoded from the CBOR stream encodes a number larger than what can
* be represented in a variable of type \c{int}. If detecting that case is
* be represented in a variable of type \c int. If detecting that case is
* important, the code should call cbor_value_get_int_checked() instead.
*
* <h3 class="groupheader">Memory and parsing constraints</h3>
Expand Down Expand Up @@ -134,12 +134,10 @@
*
* \if privatedocs
* Implementation details: the CborValue contains these fields:
* \list
* \li ptr: pointer to the actual data
* \li flags: flags from the decoder
* \li extra: partially decoded integer value (0, 1 or 2 bytes)
* \li remaining: remaining items in this collection after this item or UINT32_MAX if length is unknown
* \endlist
* - ptr: pointer to the actual data
* - flags: flags from the decoder
* - extra: partially decoded integer value (0, 1 or 2 bytes)
* - remaining: remaining items in this collection after this item or UINT32_MAX if length is unknown
* \endif
*/

Expand Down Expand Up @@ -429,12 +427,10 @@ CborError cbor_value_reparse(CborValue *it)
* will appear during parsing.
*
* A basic validation checks for:
* \list
* \li absence of undefined additional information bytes;
* \li well-formedness of all numbers, lengths, and simple values;
* \li string contents match reported sizes;
* \li arrays and maps contain the number of elements they are reported to have;
* \endlist
* - absence of undefined additional information bytes;
* - well-formedness of all numbers, lengths, and simple values;
* - string contents match reported sizes;
* - arrays and maps contain the number of elements they are reported to have;
*
* For further checks, see cbor_value_validate().
*
Expand Down Expand Up @@ -745,7 +741,7 @@ CborError cbor_value_leave_container(CborValue *it, const CborValue *recursed)
* \ref cbor_value_is_integer is recommended.
*
* Note that this function does not do range-checking: integral values that do
* not fit in a variable of type \c{int} are silently truncated to fit. Use
* not fit in a variable of type \c int are silently truncated to fit. Use
* cbor_value_get_int_checked() if that is not acceptable.
*
* \sa cbor_value_get_type(), cbor_value_is_valid(), cbor_value_is_integer()
Expand All @@ -760,7 +756,7 @@ CborError cbor_value_leave_container(CborValue *it, const CborValue *recursed)
* \ref cbor_value_is_integer is recommended.
*
* Note that this function does not do range-checking: integral values that do
* not fit in a variable of type \c{int64_t} are silently truncated to fit. Use
* not fit in a variable of type \c int64_t are silently truncated to fit. Use
* cbor_value_get_int64_checked() that is not acceptable.
*
* \sa cbor_value_get_type(), cbor_value_is_valid(), cbor_value_is_integer()
Expand Down Expand Up @@ -791,7 +787,7 @@ CborError cbor_value_leave_container(CborValue *it, const CborValue *recursed)
* If the integer is unsigned (that is, if cbor_value_is_unsigned_integer()
* returns true), then \a result will contain the actual value. If the integer
* is negative, then \a result will contain the absolute value of that integer,
* minus one. That is, \c {actual = -result - 1}. On architectures using two's
* minus one. That is, <tt>actual = -result - 1</tt>. On architectures using two's
* complement for representation of negative integers, it is equivalent to say
* that \a result will contain the bitwise negation of the actual value.
*
Expand Down Expand Up @@ -1244,10 +1240,10 @@ static CborError iterate_string_chunks(const CborValue *value, char *buffer, siz
* of the string in order to preallocate a buffer, use
* cbor_value_calculate_string_length().
*
* On success, this function sets the number of bytes copied to \c{*buflen}. If
* On success, this function sets the number of bytes copied to \c *buflen. If
* the buffer is large enough, this function will insert a null byte after the
* last copied byte, to facilitate manipulation of text strings. That byte is
* not included in the returned value of \c{*buflen}. If there was no space for
* not included in the returned value of \c *buflen. If there was no space for
* the terminating null, no error is returned, so callers must check the value
* of *buflen after the call, before relying on the '\0'; if it has not been
* changed by the call, there is no '\0'-termination on the buffer's contents.
Expand Down Expand Up @@ -1281,10 +1277,10 @@ static CborError iterate_string_chunks(const CborValue *value, char *buffer, siz
* of the string in order to preallocate a buffer, use
* cbor_value_calculate_string_length().
*
* On success, this function sets the number of bytes copied to \c{*buflen}. If
* On success, this function sets the number of bytes copied to \c *buflen. If
* the buffer is large enough, this function will insert a null byte after the
* last copied byte, to facilitate manipulation of null-terminated strings.
* That byte is not included in the returned value of \c{*buflen}.
* That byte is not included in the returned value of \c *buflen.
*
* The \a next pointer, if not null, will be updated to point to the next item
* after this string. If \a value points to the last item, then \a next will be
Expand Down Expand Up @@ -1521,7 +1517,7 @@ CborError cbor_value_map_find_value(const CborValue *map, const char *string, Cb
* cbor_value_is_half_float is recommended.
*
* Note: since the C language does not have a standard type for half-precision
* floating point, this function takes a \c{void *} as a parameter for the
* floating point, this function takes a <tt>void *</tt> as a parameter for the
* storage area, which must be at least 16 bits wide.
*
* \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()
Expand Down
8 changes: 4 additions & 4 deletions src/cborparser_dup_string.c
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@
* If \c malloc returns a NULL pointer, this function will return error
* condition \ref CborErrorOutOfMemory.
*
* On success, \c{*buffer} will contain a valid pointer that must be freed by
* calling \c{free()}. This is the case even for zero-length strings.
* On success, \c *buffer will contain a valid pointer that must be freed by
* calling \c free(). This is the case even for zero-length strings.
*
* The \a next pointer, if not null, will be updated to point to the next item
* after this string. If \a value points to the last item, then \a next will be
Expand Down Expand Up @@ -89,8 +89,8 @@
* If \c malloc returns a NULL pointer, this function will return error
* condition \ref CborErrorOutOfMemory.
*
* On success, \c{*buffer} will contain a valid pointer that must be freed by
* calling \c{free()}. This is the case even for zero-length strings.
* On success, \c *buffer will contain a valid pointer that must be freed by
* calling \c free(). This is the case even for zero-length strings.
*
* The \a next pointer, if not null, will be updated to point to the next item
* after this string. If \a value points to the last item, then \a next will be
Expand Down