Skip to content

Commit

Permalink
Update doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
@wolkykim
wolkykim committed Dec 16, 2015
1 parent eff0e1c commit 558c3fd
Show file tree
Hide file tree
Showing 8 changed files with 605 additions and 597 deletions.
35 changes: 18 additions & 17 deletions doc/html/README_8md_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -200,23 +200,24 @@
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<span class="stringliteral">The following people have helped with suggestions, ideas, code or fixing bugs:</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="stringliteral">(in alphabetical order by first name)</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="stringliteral">* [Anthony Tseng](https://github.com/darkdh)</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="stringliteral">* Cesar</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="stringliteral">* [Colin](https://github.com/colintd)</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="stringliteral">* [Charles](https://github.com/Charles0429)</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="stringliteral">* [Dmitry Vorobiev](https://github.com/demitsuri)</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="stringliteral">* HyoSup Woo</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="stringliteral">* [Keith Rosenberg](https://github.com/netpoetica)</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;<span class="stringliteral">* Krishna</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;<span class="stringliteral">* [Liu Zhongchao](https://github.com/haveTryTwo)</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;<span class="stringliteral">* Luis Jimenez</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;<span class="stringliteral">* Maik Beckmann</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;<span class="stringliteral">* RQ</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;<span class="stringliteral">* [Ryan Gonzalez](https://github.com/kirbyfan64)</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;<span class="stringliteral">* [Seungyoung Kim](https://github.com/wolkykim)</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<span class="stringliteral">* Umesh</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;<span class="stringliteral">If we have forgotten or misspelled your name, please let us know.</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="stringliteral">* [Alexandre Lucchesi](https://github.com/alexandrelucchesi)</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="stringliteral">* [Anthony Tseng](https://github.com/darkdh)</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="stringliteral">* Cesar</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="stringliteral">* [Colin](https://github.com/colintd)</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="stringliteral">* [Charles](https://github.com/Charles0429)</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="stringliteral">* [Dmitry Vorobiev](https://github.com/demitsuri)</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="stringliteral">* HyoSup Woo</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;<span class="stringliteral">* [Keith Rosenberg](https://github.com/netpoetica)</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;<span class="stringliteral">* Krishna</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;<span class="stringliteral">* [Liu Zhongchao](https://github.com/haveTryTwo)</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;<span class="stringliteral">* Luis Jimenez</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;<span class="stringliteral">* Maik Beckmann</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;<span class="stringliteral">* RQ</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;<span class="stringliteral">* [Ryan Gonzalez](https://github.com/kirbyfan64)</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<span class="stringliteral">* [Seungyoung Kim](https://github.com/wolkykim)</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;<span class="stringliteral">* Umesh</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;<span class="stringliteral">If we have forgotten or misspelled your name, please let us know.</span></div>
<div class="ttc" id="qlisttbl_8c_html_ace8778acce088344531b5249d580aca7"><div class="ttname"><a href="qlisttbl_8c.html#ace8778acce088344531b5249d580aca7">qlisttbl</a></div><div class="ttdeci">qlisttbl_t * qlisttbl(int options)</div><div class="ttdoc">Create a new Q_LIST linked-list container. </div><div class="ttdef"><b>Definition:</b> <a href="qlisttbl_8c_source.html#l00150">qlisttbl.c:150</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
Expand Down
1 change: 1 addition & 0 deletions doc/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ <h2>Consistent API Look</h2>
<h2>Contributors</h2>
<p>The following people have helped with suggestions, ideas, code or fixing bugs: (in alphabetical order by first name)</p>
<ul>
<li><a href="https://github.com/alexandrelucchesi">Alexandre Lucchesi</a></li>
<li><a href="https://github.com/darkdh">Anthony Tseng</a></li>
<li>Cesar</li>
<li><a href="https://github.com/colintd">Colin</a></li>
Expand Down
19 changes: 11 additions & 8 deletions doc/html/navtreeindex1.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,14 +132,17 @@ var NAVTREEINDEX1 =
"qsystem_8c.html#a572fee0d88280a0dd1f5ab0905296eea":[0,0,4,7,0],
"qsystem_8c_source.html":[0,0,4,7],
"qtime_8c.html":[0,0,4,8],
"qtime_8c.html#a0feed44026ab24d9d366c5997a2173b4":[0,0,4,8,1],
"qtime_8c.html#a1a3f24d676b909313177459cefa78899":[0,0,4,8,4],
"qtime_8c.html#a689f608f871f45fb772266bf1f18cdd7":[0,0,4,8,0],
"qtime_8c.html#a6c536941cca900b390fc199eb3b50c6b":[0,0,4,8,7],
"qtime_8c.html#a7e54e9b38d82df0fe112440a89b372dc":[0,0,4,8,6],
"qtime_8c.html#a89b28885c2bb13906855cd6c34cfaed7":[0,0,4,8,2],
"qtime_8c.html#acbacded92c55a0674eec7590b65d7a3d":[0,0,4,8,5],
"qtime_8c.html#adf628449c7e5425b5c16b61f14a51eaf":[0,0,4,8,3],
"qtime_8c.html#a0feed44026ab24d9d366c5997a2173b4":[0,0,4,8,4],
"qtime_8c.html#a1a3f24d676b909313177459cefa78899":[0,0,4,8,7],
"qtime_8c.html#a689f608f871f45fb772266bf1f18cdd7":[0,0,4,8,3],
"qtime_8c.html#a6c536941cca900b390fc199eb3b50c6b":[0,0,4,8,10],
"qtime_8c.html#a78c99ffd76a7bb3c8c74db76207e9ab4":[0,0,4,8,1],
"qtime_8c.html#a7e54e9b38d82df0fe112440a89b372dc":[0,0,4,8,9],
"qtime_8c.html#a8773045a81f883f2ab00761f45e8642c":[0,0,4,8,0],
"qtime_8c.html#a89b28885c2bb13906855cd6c34cfaed7":[0,0,4,8,5],
"qtime_8c.html#acbacded92c55a0674eec7590b65d7a3d":[0,0,4,8,8],
"qtime_8c.html#ad3d8a3bd0c0b677acef144f2c2ef6d73":[0,0,4,8,2],
"qtime_8c.html#adf628449c7e5425b5c16b61f14a51eaf":[0,0,4,8,6],
"qtime_8c_source.html":[0,0,4,8],
"qtokenbucket_8c.html":[0,0,1,5],
"qtokenbucket_8c.html#a5464647c7e3874f8517fdbe787ee6ce3":[0,0,1,5,2],
Expand Down
30 changes: 15 additions & 15 deletions doc/html/qhashtbl_8c.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ <h2 class="groupheader">Function Documentation</h2>
</dd>
</dl>

<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00199">199</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>
<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00198">198</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -360,7 +360,7 @@ <h2 class="groupheader">Function Documentation</h2>
</dd>
</dl>

<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00280">280</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>
<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00279">279</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -421,7 +421,7 @@ <h2 class="groupheader">Function Documentation</h2>
</dd>
</dl>

<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00296">296</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>
<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00295">295</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -477,7 +477,7 @@ <h2 class="groupheader">Function Documentation</h2>
</dl>
<dl class="section note"><dt>Note</dt><dd>The integer will be converted to a string object and stored as string object. </dd></dl>

<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00324">324</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>
<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00323">323</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -552,7 +552,7 @@ <h2 class="groupheader">Function Documentation</h2>
<div class="line">free(data);</div>
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>If newmem flag is set, returned data will be malloced and should be deallocated by user. Otherwise returned pointer will point internal buffer directly and should not be de-allocated by user. In thread-safe mode, newmem flag must be set to true always. </dd></dl>

<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00364">364</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>
<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00363">363</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -609,7 +609,7 @@ <h2 class="groupheader">Function Documentation</h2>
</dl>
<dl class="section note"><dt>Note</dt><dd>If newmem flag is set, returned data will be malloced and should be deallocated by user. </dd></dl>

<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00423">423</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>
<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00422">422</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -658,7 +658,7 @@ <h2 class="groupheader">Function Documentation</h2>
</dd>
</dl>

<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00440">440</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>
<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00439">439</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -706,7 +706,7 @@ <h2 class="groupheader">Function Documentation</h2>
</dd>
</dl>

<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00462">462</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>
<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00461">461</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -775,7 +775,7 @@ <h2 class="groupheader">Function Documentation</h2>
<div class="line">tbl-&gt;unlock(tbl);</div>
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>locking must be provided on user code when all element scan must be guaranteed where multiple threads concurrently update the table. It's ok not to lock the table on the user code even in thread condition, when concurreny is importand and all element scan in a path doesn't need to be guaranteed. In this case, new data inserted during the traversal will be show up in this scan or next scan. Make sure newmem flag is set if deletion is expected during the scan. Object obj should be initialized with 0 by using memset() before first call. </dd></dl>

<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00544">544</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>
<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00543">543</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>

</div>
</div>
Expand All @@ -802,7 +802,7 @@ <h2 class="groupheader">Function Documentation</h2>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of elements stored </dd></dl>

<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00614">614</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>
<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00613">613</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>

</div>
</div>
Expand All @@ -828,7 +828,7 @@ <h2 class="groupheader">Function Documentation</h2>
</dd>
</dl>

<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00623">623</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>
<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00622">622</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -875,7 +875,7 @@ <h2 class="groupheader">Function Documentation</h2>
</dd>
</dl>

<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00655">655</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>
<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00654">654</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>

</div>
</div>
Expand Down Expand Up @@ -904,7 +904,7 @@ <h2 class="groupheader">Function Documentation</h2>
<dd>
This operation will do nothing if QHASHTBL_THREADSAFE option was not given at the initialization time. </dd></dl>

<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00687">687</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>
<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00686">686</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>

</div>
</div>
Expand All @@ -931,7 +931,7 @@ <h2 class="groupheader">Function Documentation</h2>
</dl>
<dl class="section note"><dt>Note</dt><dd>This operation will do nothing if QHASHTBL_THREADSAFE option was not given at the initialization time. </dd></dl>

<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00700">700</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>
<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00699">699</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>

</div>
</div>
Expand All @@ -957,7 +957,7 @@ <h2 class="groupheader">Function Documentation</h2>
</dd>
</dl>

<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00709">709</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>
<p>Definition at line <a class="el" href="qhashtbl_8c_source.html#l00708">708</a> of file <a class="el" href="qhashtbl_8c_source.html">qhashtbl.c</a>.</p>

</div>
</div>
Expand Down
Loading

0 comments on commit 558c3fd

Please sign in to comment.