Laurence Lundblade | 55ea951 | 2024-12-18 22:01:08 -0700 | [diff] [blame] | 1 | /*! @mainpage QCBOR Documentation |
| 2 | |
| 3 | @par Table of Contents |
| 4 | |
| 5 | API Reference |
Laurence Lundblade | c8a693e | 2024-12-28 12:29:27 -0500 | [diff] [blame] | 6 | - 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 | |
| 18 | Note: the API Reference is largely complete, the subject matter below is partial |
Laurence Lundblade | 55ea951 | 2024-12-18 22:01:08 -0700 | [diff] [blame] | 19 | |
| 20 | Subject Matter |
Laurence Lundblade | c8a693e | 2024-12-28 12:29:27 -0500 | [diff] [blame] | 21 | - @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 Lundblade | 55ea951 | 2024-12-18 22:01:08 -0700 | [diff] [blame] | 29 | |
| 30 | */ |