Skip to content

Commit 65a4147

Browse files
pjonssonthiagomacieira
authored andcommitted
Fix Doxygen warnings
The \c and \b commands accept a single word, and there are no \section1 or \list commands according to the Doxygen manual.
1 parent 8b3e97d commit 65a4147

File tree

3 files changed

+23
-27
lines changed

3 files changed

+23
-27
lines changed

src/cborencoder.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@
102102
* complete the encoding. At the end, you can obtain that count by calling
103103
* cbor_encoder_get_extra_bytes_needed().
104104
*
105-
* \section1 Finalizing the encoding
105+
* \section Finalizing the encoding
106106
*
107107
* Once all items have been appended and the containers have all been properly
108108
* closed, the user-supplied buffer will contain the CBOR stream and may be
@@ -545,7 +545,7 @@ CborError cbor_encoder_create_array(CborEncoder *parentEncoder, CborEncoder *arr
545545
* when creating the map, the constant \ref CborIndefiniteLength may be passed as
546546
* length instead, and an indefinite length map is created.
547547
*
548-
* \b{Implementation limitation:} TinyCBOR cannot encode more than SIZE_MAX/2
548+
* <b>Implementation limitation:</b> TinyCBOR cannot encode more than SIZE_MAX/2
549549
* key-value pairs in the stream. If the length \a length is larger than this
550550
* value (and is not \ref CborIndefiniteLength), this function returns error
551551
* CborErrorDataTooLarge.

src/cborparser.c

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494
*
9595
* The code above does not execute a range-check either: it is possible that
9696
* 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
9898
* important, the code should call cbor_value_get_int_checked() instead.
9999
*
100100
* <h3 class="groupheader">Memory and parsing constraints</h3>
@@ -134,12 +134,10 @@
134134
*
135135
* \if privatedocs
136136
* 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
143141
* \endif
144142
*/
145143

@@ -429,12 +427,10 @@ CborError cbor_value_reparse(CborValue *it)
429427
* will appear during parsing.
430428
*
431429
* 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;
438434
*
439435
* For further checks, see cbor_value_validate().
440436
*
@@ -745,7 +741,7 @@ CborError cbor_value_leave_container(CborValue *it, const CborValue *recursed)
745741
* \ref cbor_value_is_integer is recommended.
746742
*
747743
* 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
749745
* cbor_value_get_int_checked() if that is not acceptable.
750746
*
751747
* \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)
760756
* \ref cbor_value_is_integer is recommended.
761757
*
762758
* 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
764760
* cbor_value_get_int64_checked() that is not acceptable.
765761
*
766762
* \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)
791787
* If the integer is unsigned (that is, if cbor_value_is_unsigned_integer()
792788
* returns true), then \a result will contain the actual value. If the integer
793789
* 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
795791
* complement for representation of negative integers, it is equivalent to say
796792
* that \a result will contain the bitwise negation of the actual value.
797793
*
@@ -1244,10 +1240,10 @@ static CborError iterate_string_chunks(const CborValue *value, char *buffer, siz
12441240
* of the string in order to preallocate a buffer, use
12451241
* cbor_value_calculate_string_length().
12461242
*
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
12481244
* the buffer is large enough, this function will insert a null byte after the
12491245
* 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
12511247
* the terminating null, no error is returned, so callers must check the value
12521248
* of *buflen after the call, before relying on the '\0'; if it has not been
12531249
* 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
12811277
* of the string in order to preallocate a buffer, use
12821278
* cbor_value_calculate_string_length().
12831279
*
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
12851281
* the buffer is large enough, this function will insert a null byte after the
12861282
* 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.
12881284
*
12891285
* The \a next pointer, if not null, will be updated to point to the next item
12901286
* 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
15211517
* cbor_value_is_half_float is recommended.
15221518
*
15231519
* 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
15251521
* storage area, which must be at least 16 bits wide.
15261522
*
15271523
* \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()

src/cborparser_dup_string.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@
5858
* If \c malloc returns a NULL pointer, this function will return error
5959
* condition \ref CborErrorOutOfMemory.
6060
*
61-
* On success, \c{*buffer} will contain a valid pointer that must be freed by
62-
* calling \c{free()}. This is the case even for zero-length strings.
61+
* On success, \c *buffer will contain a valid pointer that must be freed by
62+
* calling \c free(). This is the case even for zero-length strings.
6363
*
6464
* The \a next pointer, if not null, will be updated to point to the next item
6565
* after this string. If \a value points to the last item, then \a next will be
@@ -89,8 +89,8 @@
8989
* If \c malloc returns a NULL pointer, this function will return error
9090
* condition \ref CborErrorOutOfMemory.
9191
*
92-
* On success, \c{*buffer} will contain a valid pointer that must be freed by
93-
* calling \c{free()}. This is the case even for zero-length strings.
92+
* On success, \c *buffer will contain a valid pointer that must be freed by
93+
* calling \c free(). This is the case even for zero-length strings.
9494
*
9595
* The \a next pointer, if not null, will be updated to point to the next item
9696
* after this string. If \a value points to the last item, then \a next will be

0 commit comments

Comments
 (0)