xref: /netbsd-src/external/mit/libcbor/dist/docs/doxygen/index.html (revision 5dd36a3bc8bf2a9dec29ceb6349550414570c447)
1*5dd36a3bSchristos<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2*5dd36a3bSchristos<html xmlns="http://www.w3.org/1999/xhtml">
3*5dd36a3bSchristos<head>
4*5dd36a3bSchristos<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5*5dd36a3bSchristos<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6*5dd36a3bSchristos<meta name="generator" content="Doxygen 1.8.12"/>
7*5dd36a3bSchristos<meta name="viewport" content="width=device-width, initial-scale=1"/>
8*5dd36a3bSchristos<title>libcbor: Main Page</title>
9*5dd36a3bSchristos<link href="tabs.css" rel="stylesheet" type="text/css"/>
10*5dd36a3bSchristos<script type="text/javascript" src="jquery.js"></script>
11*5dd36a3bSchristos<script type="text/javascript" src="dynsections.js"></script>
12*5dd36a3bSchristos<link href="search/search.css" rel="stylesheet" type="text/css"/>
13*5dd36a3bSchristos<script type="text/javascript" src="search/searchdata.js"></script>
14*5dd36a3bSchristos<script type="text/javascript" src="search/search.js"></script>
15*5dd36a3bSchristos<link href="doxygen.css" rel="stylesheet" type="text/css" />
16*5dd36a3bSchristos<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
17*5dd36a3bSchristos</head>
18*5dd36a3bSchristos<body>
19*5dd36a3bSchristos<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
20*5dd36a3bSchristos<div id="titlearea">
21*5dd36a3bSchristos<table cellspacing="0" cellpadding="0">
22*5dd36a3bSchristos <tbody>
23*5dd36a3bSchristos <tr style="height: 56px;">
24*5dd36a3bSchristos  <td id="projectalign" style="padding-left: 0.5em;">
25*5dd36a3bSchristos   <div id="projectname">libcbor
26*5dd36a3bSchristos   &#160;<span id="projectnumber">0.5.0</span>
27*5dd36a3bSchristos   </div>
28*5dd36a3bSchristos   <div id="projectbrief">libcbor is a C library for parsing and generating CBOR, the general-purpose schema-less binary data format.</div>
29*5dd36a3bSchristos  </td>
30*5dd36a3bSchristos </tr>
31*5dd36a3bSchristos </tbody>
32*5dd36a3bSchristos</table>
33*5dd36a3bSchristos</div>
34*5dd36a3bSchristos<!-- end header part -->
35*5dd36a3bSchristos<!-- Generated by Doxygen 1.8.12 -->
36*5dd36a3bSchristos<script type="text/javascript">
37*5dd36a3bSchristosvar searchBox = new SearchBox("searchBox", "search",false,'Search');
38*5dd36a3bSchristos</script>
39*5dd36a3bSchristos<script type="text/javascript" src="menudata.js"></script>
40*5dd36a3bSchristos<script type="text/javascript" src="menu.js"></script>
41*5dd36a3bSchristos<script type="text/javascript">
42*5dd36a3bSchristos$(function() {
43*5dd36a3bSchristos  initMenu('',true,false,'search.php','Search');
44*5dd36a3bSchristos  $(document).ready(function() { init_search(); });
45*5dd36a3bSchristos});
46*5dd36a3bSchristos</script>
47*5dd36a3bSchristos<div id="main-nav"></div>
48*5dd36a3bSchristos</div><!-- top -->
49*5dd36a3bSchristos<!-- window showing the filter options -->
50*5dd36a3bSchristos<div id="MSearchSelectWindow"
51*5dd36a3bSchristos     onmouseover="return searchBox.OnSearchSelectShow()"
52*5dd36a3bSchristos     onmouseout="return searchBox.OnSearchSelectHide()"
53*5dd36a3bSchristos     onkeydown="return searchBox.OnSearchSelectKey(event)">
54*5dd36a3bSchristos</div>
55*5dd36a3bSchristos
56*5dd36a3bSchristos<!-- iframe showing the search results (closed by default) -->
57*5dd36a3bSchristos<div id="MSearchResultsWindow">
58*5dd36a3bSchristos<iframe src="javascript:void(0)" frameborder="0"
59*5dd36a3bSchristos        name="MSearchResults" id="MSearchResults">
60*5dd36a3bSchristos</iframe>
61*5dd36a3bSchristos</div>
62*5dd36a3bSchristos
63*5dd36a3bSchristos<div class="header">
64*5dd36a3bSchristos  <div class="headertitle">
65*5dd36a3bSchristos<div class="title">libcbor Documentation</div>  </div>
66*5dd36a3bSchristos</div><!--header-->
67*5dd36a3bSchristos<div class="contents">
68*5dd36a3bSchristos<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*5dd36a3bSchristos<h1>Where to start</h1>
70*5dd36a3bSchristos<p>A couple of pointers for you to start with: <code>0x00000000</code>, <code>0xDEADBEEF</code>.</p>
71*5dd36a3bSchristos<p>If you just want to peek under the hood, have a look at:</p><ul>
72*5dd36a3bSchristos<li><a class="el" href="common_8h.html">src/cbor/common.h</a></li>
73*5dd36a3bSchristos<li><a class="el" href="encoding_8h.html">src/cbor/encoding.h</a></li>
74*5dd36a3bSchristos<li><a class="el" href="cbor_8h.html">src/cbor.h</a></li>
75*5dd36a3bSchristos</ul>
76*5dd36a3bSchristos<p>If you want to implement your own decoder or see how the default one is made:</p><ul>
77*5dd36a3bSchristos<li><a class="el" href="builder__callbacks_8h.html">src/cbor/internal/builder_callbacks.h</a></li>
78*5dd36a3bSchristos<li><a class="el" href="stack_8h.html">src/cbor/internal/stack.h</a></li>
79*5dd36a3bSchristos</ul>
80*5dd36a3bSchristos<p>For details on encoding and packing (could be useful when porting to exotic platforms):</p><ul>
81*5dd36a3bSchristos<li><a class="el" href="encoders_8h.html">src/cbor/internal/encoders.h</a></li>
82*5dd36a3bSchristos<li><a class="el" href="loaders_8h.html">src/cbor/internal/loaders.h</a></li>
83*5dd36a3bSchristos</ul>
84*5dd36a3bSchristos<p>Streaming driver:</p><ul>
85*5dd36a3bSchristos<li><a class="el" href="streaming_8h.html">src/cbor/streaming.h</a></li>
86*5dd36a3bSchristos</ul>
87*5dd36a3bSchristos<p>Manipulation routines for particular types:</p><ul>
88*5dd36a3bSchristos<li><a class="el" href="ints_8h.html">src/cbor/ints.h</a></li>
89*5dd36a3bSchristos<li><a class="el" href="bytestrings_8h.html">src/cbor/bytestrings.h</a></li>
90*5dd36a3bSchristos<li><a class="el" href="strings_8h.html">src/cbor/strings.h</a></li>
91*5dd36a3bSchristos<li><a class="el" href="arrays_8h.html">src/cbor/arrays.h</a></li>
92*5dd36a3bSchristos<li><a class="el" href="maps_8h.html">src/cbor/maps.h</a></li>
93*5dd36a3bSchristos<li><a class="el" href="tags_8h.html">src/cbor/tags.h</a></li>
94*5dd36a3bSchristos<li><a class="el" href="floats__ctrls_8h.html">src/cbor/floats_ctrls.h</a></li>
95*5dd36a3bSchristos</ul>
96*5dd36a3bSchristos<h1>How to contribute</h1>
97*5dd36a3bSchristos<p>Please refer to <a href="https://github.com/PJK/libcbor">the repository</a> </p>
98*5dd36a3bSchristos</div></div><!-- contents -->
99*5dd36a3bSchristos<!-- start footer part -->
100*5dd36a3bSchristos<hr class="footer"/><address class="footer"><small>
101*5dd36a3bSchristosGenerated on Mon Feb 6 2017 00:26:19 for libcbor by &#160;<a href="http://www.doxygen.org/index.html">
102*5dd36a3bSchristos<img class="footer" src="doxygen.png" alt="doxygen"/>
103*5dd36a3bSchristos</a> 1.8.12
104*5dd36a3bSchristos</small></address>
105*5dd36a3bSchristos</body>
106*5dd36a3bSchristos</html>
107