| Laurence Lundblade | 55ea951 | 2024-12-18 22:01:08 -0700 | [diff] [blame] | 1 | /*! @mainpage QCBOR Documentation |
| 2 | |
| Laurence Lundblade | bb98796 | 2025-01-20 23:14:07 -0700 | [diff] [blame] | 3 | QCBOR can be downloaded from its [GitHub repository](https://github.com/laurencelundblade/QCBOR). |
| 4 | This documentation corresponds to QCBOR v2, currently in its alpha release |
| 5 | phase. While much of the content also applies to v1 -- which is stable, |
| 6 | commercially suitable, and compatible with v2 -- it's important to note that |
| 7 | v2 introduces new features and APIs not available in v1. |
| Laurence Lundblade | 89f926d | 2025-01-01 19:37:09 -0700 | [diff] [blame] | 8 | |
| Laurence Lundblade | 55ea951 | 2024-12-18 22:01:08 -0700 | [diff] [blame] | 9 | @par Table of Contents |
| 10 | |
| Laurence Lundblade | 89f926d | 2025-01-01 19:37:09 -0700 | [diff] [blame] | 11 | API Reference: |
| Laurence Lundblade | c8a693e | 2024-12-28 12:29:27 -0500 | [diff] [blame] | 12 | - Common |
| 13 | - Error codes and common constants: @ref inc/qcbor/qcbor_common.h "qcbor_common.h" |
| Laurence Lundblade | 89f926d | 2025-01-01 19:37:09 -0700 | [diff] [blame] | 14 | - Functions for managing buffers of binary data: @ref inc/qcbor/UsefulBuf.h "UsefulBuf.h" |
| Laurence Lundblade | c8a693e | 2024-12-28 12:29:27 -0500 | [diff] [blame] | 15 | - Encoding |
| 16 | - Main/Basic encode functions: @ref inc/qcbor/qcbor_main_encode.h "qcbor_main_encode.h" |
| 17 | - Number encode functions: @ref inc/qcbor/qcbor_number_encode.h "qcbor_number_encode.h" |
| 18 | - Tag encode functions: @ref inc/qcbor/qcbor_tag_encode.h "qcbor_tag_encode.h" |
| 19 | - Decoding |
| 20 | - Main/Basic decode functions: @ref inc/qcbor/qcbor_main_decode.h "qcbor_main_decode.h" |
| 21 | - Spiffy decode functions: @ref inc/qcbor/qcbor_spiffy_decode.h "qcbor_spiffy_decode.h" |
| 22 | - Tag decode functions: @ref inc/qcbor/qcbor_tag_decode.h "qcbor_tag_decode.h" |
| 23 | - Number decode functions: @ref inc/qcbor/qcbor_number_decode.h "qcbor_number_decode.h" |
| 24 | |
| Laurence Lundblade | 89f926d | 2025-01-01 19:37:09 -0700 | [diff] [blame] | 25 | Subject Matter: |
| Laurence Lundblade | c8a693e | 2024-12-28 12:29:27 -0500 | [diff] [blame] | 26 | - @ref Overview "QCBOR overview and implementation limits" |
| 27 | - @ref Building "Building QCBOR with make and cmake" |
| 28 | - @ref CodeSize "Minimizing the amount of code linked and disabling features" |
| 29 | - @ref SpiffyDecode "The 'spiffy' decode functions for easier map decoding" |
| 30 | - CBOR Numbers |
| 31 | - @ref BigNumbers "Characteristics, encoding and decoding big numbers" |
| 32 | - Tags |
| 33 | - @ref CBORTags |
| Laurence Lundblade | 55ea951 | 2024-12-18 22:01:08 -0700 | [diff] [blame] | 34 | |
| 35 | */ |