xref: /netbsd-src/external/mit/libcbor/dist/doc/doxy_frontpage.md (revision 5dd36a3bc8bf2a9dec29ceb6349550414570c447)
1*5dd36a3bSchristos
2*5dd36a3bSchristos
3*5dd36a3bSchristosThis 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/).
4*5dd36a3bSchristos
5*5dd36a3bSchristos
6*5dd36a3bSchristos# Where to start
7*5dd36a3bSchristos
8*5dd36a3bSchristosA couple of pointers for you to start with: `0x00000000`, `0xDEADBEEF`.
9*5dd36a3bSchristos
10*5dd36a3bSchristosIf you just want to peek under the hood, have a look at:
11*5dd36a3bSchristos - \ref src/cbor/common.h
12*5dd36a3bSchristos - \ref src/cbor/encoding.h
13*5dd36a3bSchristos - \ref src/cbor.h
14*5dd36a3bSchristos
15*5dd36a3bSchristosIf you want to implement your own decoder or see how the default one is made:
16*5dd36a3bSchristos - \ref src/cbor/internal/builder_callbacks.h
17*5dd36a3bSchristos - \ref src/cbor/internal/stack.h
18*5dd36a3bSchristos
19*5dd36a3bSchristosFor details on encoding and packing (could be useful when porting to exotic platforms):
20*5dd36a3bSchristos - \ref src/cbor/internal/encoders.h
21*5dd36a3bSchristos - \ref src/cbor/internal/loaders.h
22*5dd36a3bSchristos
23*5dd36a3bSchristosStreaming driver:
24*5dd36a3bSchristos - \ref src/cbor/streaming.h
25*5dd36a3bSchristos
26*5dd36a3bSchristosManipulation routines for particular types:
27*5dd36a3bSchristos - \ref src/cbor/ints.h
28*5dd36a3bSchristos - \ref src/cbor/bytestrings.h
29*5dd36a3bSchristos - \ref src/cbor/strings.h
30*5dd36a3bSchristos - \ref src/cbor/arrays.h
31*5dd36a3bSchristos - \ref src/cbor/maps.h
32*5dd36a3bSchristos - \ref src/cbor/tags.h
33*5dd36a3bSchristos - \ref src/cbor/floats_ctrls.h
34*5dd36a3bSchristos
35*5dd36a3bSchristos# How to contribute
36*5dd36a3bSchristos
37*5dd36a3bSchristosPlease refer to [the repository](https://github.com/PJK/libcbor)
38