1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xmlns="http://www.w3.org/1999/xhtml"> 3<head> 4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5<meta http-equiv="X-UA-Compatible" content="IE=9"/> 6<meta name="generator" content="Doxygen 1.8.12"/> 7<meta name="viewport" content="width=device-width, initial-scale=1"/> 8<title>libcbor: doc/doxy_frontpage.md Source File</title> 9<link href="tabs.css" rel="stylesheet" type="text/css"/> 10<script type="text/javascript" src="jquery.js"></script> 11<script type="text/javascript" src="dynsections.js"></script> 12<link href="search/search.css" rel="stylesheet" type="text/css"/> 13<script type="text/javascript" src="search/searchdata.js"></script> 14<script type="text/javascript" src="search/search.js"></script> 15<link href="doxygen.css" rel="stylesheet" type="text/css" /> 16<link href="customdoxygen.css" rel="stylesheet" type="text/css"/> 17</head> 18<body> 19<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 20<div id="titlearea"> 21<table cellspacing="0" cellpadding="0"> 22 <tbody> 23 <tr style="height: 56px;"> 24 <td id="projectalign" style="padding-left: 0.5em;"> 25 <div id="projectname">libcbor 26  <span id="projectnumber">0.5.0</span> 27 </div> 28 <div id="projectbrief">libcbor is a C library for parsing and generating CBOR, the general-purpose schema-less binary data format.</div> 29 </td> 30 </tr> 31 </tbody> 32</table> 33</div> 34<!-- end header part --> 35<!-- Generated by Doxygen 1.8.12 --> 36<script type="text/javascript"> 37var searchBox = new SearchBox("searchBox", "search",false,'Search'); 38</script> 39<script type="text/javascript" src="menudata.js"></script> 40<script type="text/javascript" src="menu.js"></script> 41<script type="text/javascript"> 42$(function() { 43 initMenu('',true,false,'search.php','Search'); 44 $(document).ready(function() { init_search(); }); 45}); 46</script> 47<div id="main-nav"></div> 48</div><!-- top --> 49<!-- window showing the filter options --> 50<div id="MSearchSelectWindow" 51 onmouseover="return searchBox.OnSearchSelectShow()" 52 onmouseout="return searchBox.OnSearchSelectHide()" 53 onkeydown="return searchBox.OnSearchSelectKey(event)"> 54</div> 55 56<!-- iframe showing the search results (closed by default) --> 57<div id="MSearchResultsWindow"> 58<iframe src="javascript:void(0)" frameborder="0" 59 name="MSearchResults" id="MSearchResults"> 60</iframe> 61</div> 62 63<div class="header"> 64 <div class="headertitle"> 65<div class="title">doc/doxy_frontpage.md</div> </div> 66</div><!--header--> 67<div class="contents"> 68<a href="doxy__frontpage_8md.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> 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/).</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> # Where to start</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> A couple of pointers for you to start with: `0x00000000`, `0xDEADBEEF`.</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> If you just want to peek under the hood, have a look at:</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  - \ref src/cbor/common.h</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  - \ref src/cbor/encoding.h</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  - \ref src/cbor.h</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> If you want to implement your own decoder or see how the default one is made:</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  - \ref src/cbor/internal/builder_callbacks.h</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  - \ref src/cbor/internal/stack.h</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> For details on encoding and packing (could be useful when porting to exotic platforms):</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  - \ref src/cbor/internal/encoders.h</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  - \ref src/cbor/internal/loaders.h</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> Streaming driver:</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  - \ref src/cbor/streaming.h</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> Manipulation routines for particular types:</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  - \ref src/cbor/ints.h</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  - \ref src/cbor/bytestrings.h</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  - \ref src/cbor/strings.h</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  - \ref src/cbor/arrays.h</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  - \ref src/cbor/maps.h</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  - \ref src/cbor/tags.h</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  - \ref src/cbor/floats_ctrls.h</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> # How to contribute</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> Please refer to [the repository](https://github.com/PJK/libcbor)</div></div><!-- fragment --></div><!-- contents --> 69<!-- start footer part --> 70<hr class="footer"/><address class="footer"><small> 71Generated on Mon Feb 6 2017 00:26:19 for libcbor by  <a href="http://www.doxygen.org/index.html"> 72<img class="footer" src="doxygen.png" alt="doxygen"/> 73</a> 1.8.12 74</small></address> 75</body> 76</html> 77
