summaryrefslogtreecommitdiff
path: root/external/mit/libcbor/dist/doc/doxy_frontpage.md
blob: b4961b395d6f5c3c6dfec56441f587bb76347873 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37


This is the development reference of [libcbor](http://libcbor.org/). If you are looking for the user documentation, you should probably head to the [homepage](http://libcbor.org/).


# Where to start

A couple of pointers for you to start with: `0x00000000`, `0xDEADBEEF`.

If you just want to peek under the hood, have a look at:
 - \ref src/cbor/common.h
 - \ref src/cbor/encoding.h
 - \ref src/cbor.h

If you want to implement your own decoder or see how the default one is made:
 - \ref src/cbor/internal/builder_callbacks.h
 - \ref src/cbor/internal/stack.h

For details on encoding and packing (could be useful when porting to exotic platforms):
 - \ref src/cbor/internal/encoders.h
 - \ref src/cbor/internal/loaders.h

Streaming driver:
 - \ref src/cbor/streaming.h

Manipulation routines for particular types:
 - \ref src/cbor/ints.h
 - \ref src/cbor/bytestrings.h
 - \ref src/cbor/strings.h
 - \ref src/cbor/arrays.h
 - \ref src/cbor/maps.h
 - \ref src/cbor/tags.h
 - \ref src/cbor/floats_ctrls.h

# How to contribute

Please refer to [the repository](https://github.com/PJK/libcbor)