Skip to content

Commit

Permalink
Doc update & rebuild
Browse files Browse the repository at this point in the history
  • Loading branch information
wolkykim committed Nov 8, 2016
1 parent f6b1e29 commit cb882d4
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 30 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ The following people have helped with suggestions, ideas, code or fixing bugs:
* Maik Beckmann
* RQ
* [Ryan Gonzalez](https://github.com/kirbyfan64)
* [Seungyoung "Steve" Kim](https://github.com/wolkykim) - The Author
* [Seungyoung "Steve" Kim](https://github.com/wolkykim) - Project Lead
* Umesh

If we have forgotten or misspelled your name, please let us know.
33 changes: 17 additions & 16 deletions doc/html/README_8md_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -202,22 +202,23 @@
<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">* [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="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="stringliteral">* [Carpentier Pierre-Francois](https://github.com/kakwa)</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="stringliteral">* Cesar</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="stringliteral">* [Colin](https://github.com/colintd)</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="stringliteral">* [Charles](https://github.com/Charles0429)</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="stringliteral">* [Dmitry Vorobiev](https://github.com/demitsuri)</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;<span class="stringliteral">* HyoSup Woo</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;<span class="stringliteral">* [Keith Rosenberg](https://github.com/netpoetica)</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;<span class="stringliteral">* Krishna</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;<span class="stringliteral">* [Liu Zhongchao](https://github.com/haveTryTwo)</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;<span class="stringliteral">* Luis Jimenez</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;<span class="stringliteral">* Maik Beckmann</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;<span class="stringliteral">* RQ</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<span class="stringliteral">* [Ryan Gonzalez](https://github.com/kirbyfan64)</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;<span class="stringliteral">* [Seungyoung &quot;Steve&quot; Kim](https://github.com/wolkykim) - Project Lead</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;<span class="stringliteral">* Umesh</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;<span class="stringliteral"></span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</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
3 changes: 2 additions & 1 deletion doc/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@ <h2>Contributors</h2>
<ul>
<li><a href="https://github.com/alexandrelucchesi">Alexandre Lucchesi</a></li>
<li><a href="https://github.com/darkdh">Anthony Tseng</a></li>
<li><a href="https://github.com/kakwa">Carpentier Pierre-Francois</a></li>
<li>Cesar</li>
<li><a href="https://github.com/colintd">Colin</a></li>
<li><a href="https://github.com/Charles0429">Charles</a></li>
Expand All @@ -197,7 +198,7 @@ <h2>Contributors</h2>
<li>Maik Beckmann</li>
<li>RQ</li>
<li><a href="https://github.com/kirbyfan64">Ryan Gonzalez</a></li>
<li><a href="https://github.com/wolkykim">Seungyoung Kim</a></li>
<li><a href="https://github.com/wolkykim">Seungyoung "Steve" Kim</a> - Project Lead</li>
<li>Umesh</li>
</ul>
<p>If we have forgotten or misspelled your name, please let us know. </p>
Expand Down
12 changes: 6 additions & 6 deletions doc/html/qstring_8c.html
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer of source string if rsuccessful, otherewise returns NULL</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer of source string if successful, otherwise returns NULL</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This modify source string directly. </dd></dl>

<p>Definition at line <a class="el" href="qstring_8c_source.html#l00055">55</a> of file <a class="el" href="qstring_8c_source.html">qstring.c</a>.</p>
Expand Down Expand Up @@ -199,7 +199,7 @@
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer of source string if rsuccessful, otherewise returns NULL</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer of source string if successful, otherwise returns NULL</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This modify source string directly. </dd></dl>

<p>Definition at line <a class="el" href="qstring_8c_source.html#l00090">90</a> of file <a class="el" href="qstring_8c_source.html">qstring.c</a>.</p>
Expand Down Expand Up @@ -227,7 +227,7 @@
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer of source string if rsuccessful, otherewise returns NULL</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer of source string if successful, otherwise returns NULL</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This modify source string directly. </dd></dl>

<p>Definition at line <a class="el" href="qstring_8c_source.html#l00116">116</a> of file <a class="el" href="qstring_8c_source.html">qstring.c</a>.</p>
Expand Down Expand Up @@ -273,7 +273,7 @@
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer of source string if successful, otherewise returns NULL</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer of source string if successful, otherwise returns NULL</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This modify source string directly.</dd></dl>
<div class="fragment"><div class="line"><span class="keywordtype">char</span> *str = strdup(<span class="stringliteral">&quot; \&quot;hello world\&quot; &quot;</span>);</div>
<div class="line"><a class="code" href="qstring_8c.html#aef51c584fd78c0430ccfb5f51c32cf71">qstrtrim</a>(str); <span class="comment">// to remove white spaces</span></div>
Expand Down Expand Up @@ -329,8 +329,8 @@
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer of malloced or source string depending on the mode if successful, otherewise returns NULL</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The mode argument has two separated character. First character is used to decide replacing method and can be 't' or 's'. The character 't' and 's' stand on [t]oken and [s]tring.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer of malloced or source string depending on the mode if successful, otherwise returns NULL</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The mode argument has two separated characters. First character is used to decide replacing method and can be 't' or 's'. The character 't' and 's' stand on [t]oken and [s]tring.</dd></dl>
<p>When 't' is given each character of the token string(third argument) will be compared with source string individually. If matched one is found. the character will be replaced with given work.</p>
<p>If 's' is given instead of 't'. Token string will be analyzed only one chunk word. So the replacement will be occured when the case of whole word matched.</p>
<p>Second character is used to decide returning memory type and can be 'n' or 'r' which are stand on [n]ew and [r]eplace.</p>
Expand Down
12 changes: 6 additions & 6 deletions doc/html/qstring_8c_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment"> * @param str source string</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"> * @return a pointer of source string if rsuccessful, otherewise returns NULL</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"> * @return a pointer of source string if successful, otherwise returns NULL</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment"> * @note This modify source string directly.</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="comment"> */</span></div>
Expand Down Expand Up @@ -150,7 +150,7 @@
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="comment"> * @param str source string</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="comment"> * @return a pointer of source string if rsuccessful, otherewise returns NULL</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="comment"> * @return a pointer of source string if successful, otherwise returns NULL</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="comment"> * @note This modify source string directly.</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="comment"> */</span></div>
Expand All @@ -176,7 +176,7 @@
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="comment"> * @param str source string</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="comment"> * @return a pointer of source string if rsuccessful, otherewise returns NULL</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="comment"> * @return a pointer of source string if successful, otherwise returns NULL</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;<span class="comment"> * @note This modify source string directly.</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;<span class="comment"> */</span></div>
Expand All @@ -203,7 +203,7 @@
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="comment"> * @param head heading character</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="comment"> * @param tail tailing character</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="comment"> * @return a pointer of source string if successful, otherewise returns NULL</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="comment"> * @return a pointer of source string if successful, otherwise returns NULL</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="comment"> * @note This modify source string directly.</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="comment"> *</span></div>
Expand Down Expand Up @@ -237,10 +237,10 @@
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;<span class="comment"> * @param word target word to be replaced</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;<span class="comment"> * @return a pointer of malloced or source string depending on the mode if</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;<span class="comment"> * successful, otherewise returns NULL</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;<span class="comment"> * successful, otherwise returns NULL</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;<span class="comment"> * @note</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;<span class="comment"> * The mode argument has two separated character. First character</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;<span class="comment"> * The mode argument has two separated characters. First character</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;<span class="comment"> * is used to decide replacing method and can be &#39;t&#39; or &#39;s&#39;.</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160;<span class="comment"> * The character &#39;t&#39; and &#39;s&#39; stand on [t]oken and [s]tring.</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;<span class="comment"> *</span></div>
Expand Down

0 comments on commit cb882d4

Please sign in to comment.