Update docs for the 0.13.1 release.

This commit is contained in:
Eric Haszlakiewicz
2018-03-05 23:18:59 -05:00
parent 991e128df5
commit 985c46fec3
77 changed files with 2513 additions and 2185 deletions

View File

@@ -3,8 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>json-c: printbuf.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
@@ -17,9 +16,9 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<td style="padding-left: 0.5em;">
<div id="projectname">json-c
&#160;<span id="projectnumber">0.13</span>
&#160;<span id="projectnumber">0.13.1</span>
</div>
</td>
</tr>
@@ -27,15 +26,21 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
@@ -58,13 +63,13 @@ Data Structures</h2></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a6f3a4dc87fab41c37e3eff42f40dc346"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a6f3a4dc87fab41c37e3eff42f40dc346">printbuf_memappend_fast</a>(p, bufptr, bufsize)</td></tr>
<tr class="memitem:a6f3a4dc87fab41c37e3eff42f40dc346"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a6f3a4dc87fab41c37e3eff42f40dc346">printbuf_memappend_fast</a>(p, bufptr, bufsize)</td></tr>
<tr class="separator:a6f3a4dc87fab41c37e3eff42f40dc346"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdd84ad88987c0166b7ba0e3f1f8f1bb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#acdd84ad88987c0166b7ba0e3f1f8f1bb">printbuf_length</a>(p)&#160;&#160;&#160;((p)-&gt;bpos)</td></tr>
<tr class="separator:acdd84ad88987c0166b7ba0e3f1f8f1bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab009973c5e15aae191e610cd70752603"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#ab009973c5e15aae191e610cd70752603">_printbuf_check_literal</a>(mystr)&#160;&#160;&#160;(&quot;&quot; mystr)</td></tr>
<tr class="separator:ab009973c5e15aae191e610cd70752603"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f30492682f5fbc59a8749b428e0e4ba"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a2f30492682f5fbc59a8749b428e0e4ba">printbuf_strappend</a>(pb, str)&#160;&#160;&#160;<a class="el" href="printbuf_8h.html#a22f09779a19db59a83e7cb8c2ce4c75f">printbuf_memappend</a> ((pb), <a class="el" href="printbuf_8h.html#ab009973c5e15aae191e610cd70752603">_printbuf_check_literal</a>(str), sizeof(str) - 1)</td></tr>
<tr class="memitem:a2f30492682f5fbc59a8749b428e0e4ba"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="printbuf_8h.html#a2f30492682f5fbc59a8749b428e0e4ba">printbuf_strappend</a>(pb, str)&#160;&#160;&#160;<a class="el" href="printbuf_8h.html#a22f09779a19db59a83e7cb8c2ce4c75f">printbuf_memappend</a> ((pb), <a class="el" href="printbuf_8h.html#ab009973c5e15aae191e610cd70752603">_printbuf_check_literal</a>(str), sizeof(str) - 1)</td></tr>
<tr class="separator:a2f30492682f5fbc59a8749b428e0e4ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
@@ -90,9 +95,7 @@ Functions</h2></td></tr>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Internal string buffer handing. Unless you're writing a json_object_to_json_string_fn implementation for use with <a class="el" href="json__object_8h.html#a889345512a214b8f78f6a73561523c7c">json_object_set_serializer()</a> direct use of this is not recommended. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ab009973c5e15aae191e610cd70752603"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab009973c5e15aae191e610cd70752603">&#9670;&nbsp;</a></span>_printbuf_check_literal</h2>
<a class="anchor" id="ab009973c5e15aae191e610cd70752603"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -109,9 +112,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="acdd84ad88987c0166b7ba0e3f1f8f1bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdd84ad88987c0166b7ba0e3f1f8f1bb">&#9670;&nbsp;</a></span>printbuf_length</h2>
<a class="anchor" id="acdd84ad88987c0166b7ba0e3f1f8f1bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -127,9 +128,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="a6f3a4dc87fab41c37e3eff42f40dc346"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f3a4dc87fab41c37e3eff42f40dc346">&#9670;&nbsp;</a></span>printbuf_memappend_fast</h2>
<a class="anchor" id="a6f3a4dc87fab41c37e3eff42f40dc346"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -158,13 +157,18 @@ Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { \</div><div class="line"> if ((p-&gt;size - p-&gt;bpos) &gt; bufsize) { \</div><div class="line"> memcpy(p-&gt;buf + p-&gt;bpos, (bufptr), bufsize); \</div><div class="line"> p-&gt;bpos += bufsize; \</div><div class="line"> p-&gt;buf[p-&gt;bpos]= <span class="charliteral">&#39;\0&#39;</span>; \</div><div class="line"> } <span class="keywordflow">else</span> { <a class="code" href="printbuf_8h.html#a22f09779a19db59a83e7cb8c2ce4c75f">printbuf_memappend</a>(p, (bufptr), bufsize); } \</div><div class="line">} <span class="keywordflow">while</span> (0)</div><div class="ttc" id="printbuf_8h_html_a22f09779a19db59a83e7cb8c2ce4c75f"><div class="ttname"><a href="printbuf_8h.html#a22f09779a19db59a83e7cb8c2ce4c75f">printbuf_memappend</a></div><div class="ttdeci">int printbuf_memappend(struct printbuf *p, const char *buf, int size)</div></div>
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { \</div>
<div class="line"> if ((p-&gt;size - p-&gt;bpos) &gt; bufsize) { \</div>
<div class="line"> memcpy(p-&gt;buf + p-&gt;bpos, (bufptr), bufsize); \</div>
<div class="line"> p-&gt;bpos += bufsize; \</div>
<div class="line"> p-&gt;buf[p-&gt;bpos]= <span class="charliteral">&#39;\0&#39;</span>; \</div>
<div class="line"> } <span class="keywordflow">else</span> { <a class="code" href="printbuf_8h.html#a22f09779a19db59a83e7cb8c2ce4c75f">printbuf_memappend</a>(p, (bufptr), bufsize); } \</div>
<div class="line">} <span class="keywordflow">while</span> (0)</div>
<div class="ttc" id="printbuf_8h_html_a22f09779a19db59a83e7cb8c2ce4c75f"><div class="ttname"><a href="printbuf_8h.html#a22f09779a19db59a83e7cb8c2ce4c75f">printbuf_memappend</a></div><div class="ttdeci">int printbuf_memappend(struct printbuf *p, const char *buf, int size)</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a2f30492682f5fbc59a8749b428e0e4ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f30492682f5fbc59a8749b428e0e4ba">&#9670;&nbsp;</a></span>printbuf_strappend</h2>
<a class="anchor" id="a2f30492682f5fbc59a8749b428e0e4ba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -193,9 +197,7 @@ Functions</h2></td></tr>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ace274df280df67463ff417b1b3392395"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace274df280df67463ff417b1b3392395">&#9670;&nbsp;</a></span>printbuf</h2>
<a class="anchor" id="ace274df280df67463ff417b1b3392395"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -208,9 +210,7 @@ Functions</h2></td></tr>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ab525221c767ac65c58ddeea8a655a4e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab525221c767ac65c58ddeea8a655a4e8">&#9670;&nbsp;</a></span>printbuf_free()</h2>
<a class="anchor" id="ab525221c767ac65c58ddeea8a655a4e8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -226,9 +226,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="a22f09779a19db59a83e7cb8c2ce4c75f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22f09779a19db59a83e7cb8c2ce4c75f">&#9670;&nbsp;</a></span>printbuf_memappend()</h2>
<a class="anchor" id="a22f09779a19db59a83e7cb8c2ce4c75f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -260,9 +258,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="ad7fc6ec4c296e85abf404244614cded5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7fc6ec4c296e85abf404244614cded5">&#9670;&nbsp;</a></span>printbuf_memset()</h2>
<a class="anchor" id="ad7fc6ec4c296e85abf404244614cded5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -303,9 +299,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="a3e390ebc7660a18335edd89f640fd415"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e390ebc7660a18335edd89f640fd415">&#9670;&nbsp;</a></span>printbuf_new()</h2>
<a class="anchor" id="a3e390ebc7660a18335edd89f640fd415"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -321,9 +315,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="a4393ee3dedb376af11c96fe97532292e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4393ee3dedb376af11c96fe97532292e">&#9670;&nbsp;</a></span>printbuf_reset()</h2>
<a class="anchor" id="a4393ee3dedb376af11c96fe97532292e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -339,9 +331,7 @@ Functions</h2></td></tr>
</div>
</div>
<a id="adf6214db6c8ce994c7f7f1180863c8a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf6214db6c8ce994c7f7f1180863c8a4">&#9670;&nbsp;</a></span>sprintbuf()</h2>
<a class="anchor" id="adf6214db6c8ce994c7f7f1180863c8a4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -379,9 +369,9 @@ Functions</h2></td></tr>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Dec 7 2017 18:06:04 for json-c by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Mar 5 2018 23:17:09 for json-c by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</a> 1.8.8
</small></address>
</body>
</html>