blob: 2a723ceac460e15c6129bcf94b1c1d7abe9d1881 [file] [log] [blame]
Laurence Lundblade55ea9512024-12-18 22:01:08 -07001/*! @mainpage QCBOR Documentation
2
3@par Table of Contents
4
5API Reference
Laurence Lundbladec8a693e2024-12-28 12:29:27 -05006- Common
7 - Error codes and common constants: @ref inc/qcbor/qcbor_common.h "qcbor_common.h"
8- Encoding
9 - Main/Basic encode functions: @ref inc/qcbor/qcbor_main_encode.h "qcbor_main_encode.h"
10 - Number encode functions: @ref inc/qcbor/qcbor_number_encode.h "qcbor_number_encode.h"
11 - Tag encode functions: @ref inc/qcbor/qcbor_tag_encode.h "qcbor_tag_encode.h"
12- Decoding
13 - Main/Basic decode functions: @ref inc/qcbor/qcbor_main_decode.h "qcbor_main_decode.h"
14 - Spiffy decode functions: @ref inc/qcbor/qcbor_spiffy_decode.h "qcbor_spiffy_decode.h"
15 - Tag decode functions: @ref inc/qcbor/qcbor_tag_decode.h "qcbor_tag_decode.h"
16 - Number decode functions: @ref inc/qcbor/qcbor_number_decode.h "qcbor_number_decode.h"
17
18Note: the API Reference is largely complete, the subject matter below is partial
Laurence Lundblade55ea9512024-12-18 22:01:08 -070019
20Subject Matter
Laurence Lundbladec8a693e2024-12-28 12:29:27 -050021- @ref Overview "QCBOR overview and implementation limits"
22- @ref Building "Building QCBOR with make and cmake"
23- @ref CodeSize "Minimizing the amount of code linked and disabling features"
24- @ref SpiffyDecode "The 'spiffy' decode functions for easier map decoding"
25- CBOR Numbers
26 - @ref BigNumbers "Characteristics, encoding and decoding big numbers"
27- Tags
28 - @ref CBORTags
Laurence Lundblade55ea9512024-12-18 22:01:08 -070029
30*/