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: Main Page</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   &#160;<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">libcbor Documentation</div>  </div>
66</div><!--header-->
67<div class="contents">
68<div class="textblock"><p>This is the development reference of <a href="http://libcbor.org/">libcbor</a>. If you are looking for the user documentation, you should probably head to the <a href="http://libcbor.org/">homepage</a>.</p>
69<h1>Where to start</h1>
70<p>A couple of pointers for you to start with: <code>0x00000000</code>, <code>0xDEADBEEF</code>.</p>
71<p>If you just want to peek under the hood, have a look at:</p><ul>
72<li><a class="el" href="common_8h.html">src/cbor/common.h</a></li>
73<li><a class="el" href="encoding_8h.html">src/cbor/encoding.h</a></li>
74<li><a class="el" href="cbor_8h.html">src/cbor.h</a></li>
75</ul>
76<p>If you want to implement your own decoder or see how the default one is made:</p><ul>
77<li><a class="el" href="builder__callbacks_8h.html">src/cbor/internal/builder_callbacks.h</a></li>
78<li><a class="el" href="stack_8h.html">src/cbor/internal/stack.h</a></li>
79</ul>
80<p>For details on encoding and packing (could be useful when porting to exotic platforms):</p><ul>
81<li><a class="el" href="encoders_8h.html">src/cbor/internal/encoders.h</a></li>
82<li><a class="el" href="loaders_8h.html">src/cbor/internal/loaders.h</a></li>
83</ul>
84<p>Streaming driver:</p><ul>
85<li><a class="el" href="streaming_8h.html">src/cbor/streaming.h</a></li>
86</ul>
87<p>Manipulation routines for particular types:</p><ul>
88<li><a class="el" href="ints_8h.html">src/cbor/ints.h</a></li>
89<li><a class="el" href="bytestrings_8h.html">src/cbor/bytestrings.h</a></li>
90<li><a class="el" href="strings_8h.html">src/cbor/strings.h</a></li>
91<li><a class="el" href="arrays_8h.html">src/cbor/arrays.h</a></li>
92<li><a class="el" href="maps_8h.html">src/cbor/maps.h</a></li>
93<li><a class="el" href="tags_8h.html">src/cbor/tags.h</a></li>
94<li><a class="el" href="floats__ctrls_8h.html">src/cbor/floats_ctrls.h</a></li>
95</ul>
96<h1>How to contribute</h1>
97<p>Please refer to <a href="https://github.com/PJK/libcbor">the repository</a> </p>
98</div></div><!-- contents -->
99<!-- start footer part -->
100<hr class="footer"/><address class="footer"><small>
101Generated on Mon Feb 6 2017 00:26:19 for libcbor by &#160;<a href="http://www.doxygen.org/index.html">
102<img class="footer" src="doxygen.png" alt="doxygen"/>
103</a> 1.8.12
104</small></address>
105</body>
106</html>
107