Skip to content

Commit 558c3fd

Browse files
committed
Update doc.
1 parent eff0e1c commit 558c3fd

File tree

8 files changed

+605
-597
lines changed

8 files changed

+605
-597
lines changed

doc/html/README_8md_source.html

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -200,23 +200,24 @@
200200
<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>
201201
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="stringliteral">(in alphabetical order by first name)</span></div>
202202
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;<span class="stringliteral"></span></div>
203-
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="stringliteral">* [Anthony Tseng](https://github.com/darkdh)</span></div>
204-
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="stringliteral">* Cesar</span></div>
205-
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="stringliteral">* [Colin](https://github.com/colintd)</span></div>
206-
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="stringliteral">* [Charles](https://github.com/Charles0429)</span></div>
207-
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="stringliteral">* [Dmitry Vorobiev](https://github.com/demitsuri)</span></div>
208-
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="stringliteral">* HyoSup Woo</span></div>
209-
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="stringliteral">* [Keith Rosenberg](https://github.com/netpoetica)</span></div>
210-
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;<span class="stringliteral">* Krishna</span></div>
211-
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;<span class="stringliteral">* [Liu Zhongchao](https://github.com/haveTryTwo)</span></div>
212-
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;<span class="stringliteral">* Luis Jimenez</span></div>
213-
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;<span class="stringliteral">* Maik Beckmann</span></div>
214-
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;<span class="stringliteral">* RQ</span></div>
215-
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;<span class="stringliteral">* [Ryan Gonzalez](https://github.com/kirbyfan64)</span></div>
216-
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;<span class="stringliteral">* [Seungyoung Kim](https://github.com/wolkykim)</span></div>
217-
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<span class="stringliteral">* Umesh</span></div>
218-
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;<span class="stringliteral"></span></div>
219-
<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>
203+
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="stringliteral">* [Alexandre Lucchesi](https://github.com/alexandrelucchesi)</span></div>
204+
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="stringliteral">* [Anthony Tseng](https://github.com/darkdh)</span></div>
205+
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="stringliteral">* Cesar</span></div>
206+
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="stringliteral">* [Colin](https://github.com/colintd)</span></div>
207+
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="stringliteral">* [Charles](https://github.com/Charles0429)</span></div>
208+
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="stringliteral">* [Dmitry Vorobiev](https://github.com/demitsuri)</span></div>
209+
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="stringliteral">* HyoSup Woo</span></div>
210+
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;<span class="stringliteral">* [Keith Rosenberg](https://github.com/netpoetica)</span></div>
211+
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;<span class="stringliteral">* Krishna</span></div>
212+
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;<span class="stringliteral">* [Liu Zhongchao](https://github.com/haveTryTwo)</span></div>
213+
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;<span class="stringliteral">* Luis Jimenez</span></div>
214+
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;<span class="stringliteral">* Maik Beckmann</span></div>
215+
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;<span class="stringliteral">* RQ</span></div>
216+
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;<span class="stringliteral">* [Ryan Gonzalez](https://github.com/kirbyfan64)</span></div>
217+
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<span class="stringliteral">* [Seungyoung Kim](https://github.com/wolkykim)</span></div>
218+
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;<span class="stringliteral">* Umesh</span></div>
219+
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;<span class="stringliteral"></span></div>
220+
<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>
220221
<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>
221222
</div><!-- fragment --></div><!-- contents -->
222223
</div><!-- doc-content -->

doc/html/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,7 @@ <h2>Consistent API Look</h2>
183183
<h2>Contributors</h2>
184184
<p>The following people have helped with suggestions, ideas, code or fixing bugs: (in alphabetical order by first name)</p>
185185
<ul>
186+
<li><a href="https://github.com/alexandrelucchesi">Alexandre Lucchesi</a></li>
186187
<li><a href="https://github.com/darkdh">Anthony Tseng</a></li>
187188
<li>Cesar</li>
188189
<li><a href="https://github.com/colintd">Colin</a></li>

doc/html/navtreeindex1.js

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -132,14 +132,17 @@ var NAVTREEINDEX1 =
132132
"qsystem_8c.html#a572fee0d88280a0dd1f5ab0905296eea":[0,0,4,7,0],
133133
"qsystem_8c_source.html":[0,0,4,7],
134134
"qtime_8c.html":[0,0,4,8],
135-
"qtime_8c.html#a0feed44026ab24d9d366c5997a2173b4":[0,0,4,8,1],
136-
"qtime_8c.html#a1a3f24d676b909313177459cefa78899":[0,0,4,8,4],
137-
"qtime_8c.html#a689f608f871f45fb772266bf1f18cdd7":[0,0,4,8,0],
138-
"qtime_8c.html#a6c536941cca900b390fc199eb3b50c6b":[0,0,4,8,7],
139-
"qtime_8c.html#a7e54e9b38d82df0fe112440a89b372dc":[0,0,4,8,6],
140-
"qtime_8c.html#a89b28885c2bb13906855cd6c34cfaed7":[0,0,4,8,2],
141-
"qtime_8c.html#acbacded92c55a0674eec7590b65d7a3d":[0,0,4,8,5],
142-
"qtime_8c.html#adf628449c7e5425b5c16b61f14a51eaf":[0,0,4,8,3],
135+
"qtime_8c.html#a0feed44026ab24d9d366c5997a2173b4":[0,0,4,8,4],
136+
"qtime_8c.html#a1a3f24d676b909313177459cefa78899":[0,0,4,8,7],
137+
"qtime_8c.html#a689f608f871f45fb772266bf1f18cdd7":[0,0,4,8,3],
138+
"qtime_8c.html#a6c536941cca900b390fc199eb3b50c6b":[0,0,4,8,10],
139+
"qtime_8c.html#a78c99ffd76a7bb3c8c74db76207e9ab4":[0,0,4,8,1],
140+
"qtime_8c.html#a7e54e9b38d82df0fe112440a89b372dc":[0,0,4,8,9],
141+
"qtime_8c.html#a8773045a81f883f2ab00761f45e8642c":[0,0,4,8,0],
142+
"qtime_8c.html#a89b28885c2bb13906855cd6c34cfaed7":[0,0,4,8,5],
143+
"qtime_8c.html#acbacded92c55a0674eec7590b65d7a3d":[0,0,4,8,8],
144+
"qtime_8c.html#ad3d8a3bd0c0b677acef144f2c2ef6d73":[0,0,4,8,2],
145+
"qtime_8c.html#adf628449c7e5425b5c16b61f14a51eaf":[0,0,4,8,6],
143146
"qtime_8c_source.html":[0,0,4,8],
144147
"qtokenbucket_8c.html":[0,0,1,5],
145148
"qtokenbucket_8c.html#a5464647c7e3874f8517fdbe787ee6ce3":[0,0,1,5,2],

doc/html/qhashtbl_8c.html

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ <h2 class="groupheader">Function Documentation</h2>
305305
</dd>
306306
</dl>
307307

308-
<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>
308+
<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>
309309

310310
</div>
311311
</div>
@@ -360,7 +360,7 @@ <h2 class="groupheader">Function Documentation</h2>
360360
</dd>
361361
</dl>
362362

363-
<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>
363+
<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>
364364

365365
</div>
366366
</div>
@@ -421,7 +421,7 @@ <h2 class="groupheader">Function Documentation</h2>
421421
</dd>
422422
</dl>
423423

424-
<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>
424+
<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>
425425

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

480-
<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>
480+
<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>
481481

482482
</div>
483483
</div>
@@ -552,7 +552,7 @@ <h2 class="groupheader">Function Documentation</h2>
552552
<div class="line">free(data);</div>
553553
</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>
554554

555-
<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>
555+
<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>
556556

557557
</div>
558558
</div>
@@ -609,7 +609,7 @@ <h2 class="groupheader">Function Documentation</h2>
609609
</dl>
610610
<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>
611611

612-
<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>
612+
<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>
613613

614614
</div>
615615
</div>
@@ -658,7 +658,7 @@ <h2 class="groupheader">Function Documentation</h2>
658658
</dd>
659659
</dl>
660660

661-
<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>
661+
<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>
662662

663663
</div>
664664
</div>
@@ -706,7 +706,7 @@ <h2 class="groupheader">Function Documentation</h2>
706706
</dd>
707707
</dl>
708708

709-
<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>
709+
<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>
710710

711711
</div>
712712
</div>
@@ -775,7 +775,7 @@ <h2 class="groupheader">Function Documentation</h2>
775775
<div class="line">tbl-&gt;unlock(tbl);</div>
776776
</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>
777777

778-
<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>
778+
<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>
779779

780780
</div>
781781
</div>
@@ -802,7 +802,7 @@ <h2 class="groupheader">Function Documentation</h2>
802802
</dl>
803803
<dl class="section return"><dt>Returns</dt><dd>number of elements stored </dd></dl>
804804

805-
<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>
805+
<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>
806806

807807
</div>
808808
</div>
@@ -828,7 +828,7 @@ <h2 class="groupheader">Function Documentation</h2>
828828
</dd>
829829
</dl>
830830

831-
<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>
831+
<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>
832832

833833
</div>
834834
</div>
@@ -875,7 +875,7 @@ <h2 class="groupheader">Function Documentation</h2>
875875
</dd>
876876
</dl>
877877

878-
<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>
878+
<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>
879879

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

907-
<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>
907+
<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>
908908

909909
</div>
910910
</div>
@@ -931,7 +931,7 @@ <h2 class="groupheader">Function Documentation</h2>
931931
</dl>
932932
<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>
933933

934-
<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>
934+
<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>
935935

936936
</div>
937937
</div>
@@ -957,7 +957,7 @@ <h2 class="groupheader">Function Documentation</h2>
957957
</dd>
958958
</dl>
959959

960-
<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>
960+
<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>
961961

962962
</div>
963963
</div>

0 commit comments

Comments
 (0)