Skip to content

Commit

Permalink
Updated Doxygen documentations.
Browse files Browse the repository at this point in the history
  • Loading branch information
@nthnn
nthnn committed May 16, 2024
1 parent 63b95bb commit 4924772
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 124 deletions.
21 changes: 10 additions & 11 deletions docs/d1/d56/classIO-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,17 +97,16 @@
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#aad7768dadaf312424846ab8b0dd7b0ec">get_timeout</a>()</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#ab56c95632078c4b39f47c77f0f103ab7">peek</a>()</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#af67b36507b53221d03a5b7f1fd6638f0">print</a>(const string text)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a7ce5047e3cd8fa827e30a69e617ebb65">print</a>(const string text, const string fg, const string style=TERM_STYLE_NORMAL)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a07c14d06d288277bbe6aa4573c21596f">print</a>(const string text, const string fg, const string bg=TERM_BG_BLACK, const string style=TERM_STYLE_NORMAL)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a30f60dd764ba3cb47b19849297dbb7d5">print</a>(i64 number)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a60ac760446a47d3e1926ffe0120ff854">print</a>(double number)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a8082871c5668c9c33b240a7a554fd6d6">println</a>(const string text)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a347e2480a53d256289d8934f69424769">println</a>(i64 number)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a01e030ddba974247f84b2465d9151ce4">println</a>(double number)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a39320ea206b969166668dfc24b1a40bc">println</a>()</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#abd2fd0dfb704cad591e256cb8074f5b2">readch</a>()</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a9d4ca0746e40c8b8f37c1c06c3c5d411">readline</a>()</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#ac77c1571a9789636cc913425bb235bd4">set_timeout</a>(u64 timeout)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a07c14d06d288277bbe6aa4573c21596f">print</a>(const string text, const string fg, const string bg=TERM_BG_BLACK, const string style=TERM_STYLE_NORMAL)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a30f60dd764ba3cb47b19849297dbb7d5">print</a>(i64 number)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a60ac760446a47d3e1926ffe0120ff854">print</a>(double number)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a8082871c5668c9c33b240a7a554fd6d6">println</a>(const string text)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a347e2480a53d256289d8934f69424769">println</a>(i64 number)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a01e030ddba974247f84b2465d9151ce4">println</a>(double number)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a39320ea206b969166668dfc24b1a40bc">println</a>()</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#abd2fd0dfb704cad591e256cb8074f5b2">readch</a>()</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a9d4ca0746e40c8b8f37c1c06c3c5d411">readline</a>()</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#ac77c1571a9789636cc913425bb235bd4">set_timeout</a>(u64 timeout)</td><td class="entry"><a class="el" href="../../d8/d66/classIO.html">IO</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
Expand Down
64 changes: 4 additions & 60 deletions docs/d8/d66/classIO.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,6 @@
<tr class="memitem:af67b36507b53221d03a5b7f1fd6638f0"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d66/classIO.html#af67b36507b53221d03a5b7f1fd6638f0">print</a> (const <a class="el" href="../../d9/d49/types_8h.html#a338951b7e7607b65262fb051e7804d91">string</a> text)</td></tr>
<tr class="memdesc:af67b36507b53221d03a5b7f1fd6638f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print text to the output stream. <a href="../../d8/d66/classIO.html#af67b36507b53221d03a5b7f1fd6638f0">More...</a><br /></td></tr>
<tr class="separator:af67b36507b53221d03a5b7f1fd6638f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ce5047e3cd8fa827e30a69e617ebb65"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d66/classIO.html#a7ce5047e3cd8fa827e30a69e617ebb65">print</a> (const <a class="el" href="../../d9/d49/types_8h.html#a338951b7e7607b65262fb051e7804d91">string</a> text, const <a class="el" href="../../d9/d49/types_8h.html#a338951b7e7607b65262fb051e7804d91">string</a> fg, const <a class="el" href="../../d9/d49/types_8h.html#a338951b7e7607b65262fb051e7804d91">string</a> style=<a class="el" href="../../dc/dac/io_8h.html#a41b83c18bcf97d8a6f1435338edc48ae">TERM_STYLE_NORMAL</a>)</td></tr>
<tr class="memdesc:a7ce5047e3cd8fa827e30a69e617ebb65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print text to the output stream. <a href="../../d8/d66/classIO.html#a7ce5047e3cd8fa827e30a69e617ebb65">More...</a><br /></td></tr>
<tr class="separator:a7ce5047e3cd8fa827e30a69e617ebb65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07c14d06d288277bbe6aa4573c21596f"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d66/classIO.html#a07c14d06d288277bbe6aa4573c21596f">print</a> (const <a class="el" href="../../d9/d49/types_8h.html#a338951b7e7607b65262fb051e7804d91">string</a> text, const <a class="el" href="../../d9/d49/types_8h.html#a338951b7e7607b65262fb051e7804d91">string</a> fg, const <a class="el" href="../../d9/d49/types_8h.html#a338951b7e7607b65262fb051e7804d91">string</a> bg=<a class="el" href="../../dc/dac/io_8h.html#a61f7eee8e2eff7e858cfd7749678e1bc">TERM_BG_BLACK</a>, const <a class="el" href="../../d9/d49/types_8h.html#a338951b7e7607b65262fb051e7804d91">string</a> style=<a class="el" href="../../dc/dac/io_8h.html#a41b83c18bcf97d8a6f1435338edc48ae">TERM_STYLE_NORMAL</a>)</td></tr>
<tr class="memdesc:a07c14d06d288277bbe6aa4573c21596f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print text to the output stream. <a href="../../d8/d66/classIO.html#a07c14d06d288277bbe6aa4573c21596f">More...</a><br /></td></tr>
<tr class="separator:a07c14d06d288277bbe6aa4573c21596f"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -337,7 +334,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab56c95632078c4b39f47c77f
</div>
</div>
<a id="af67b36507b53221d03a5b7f1fd6638f0" name="af67b36507b53221d03a5b7f1fd6638f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af67b36507b53221d03a5b7f1fd6638f0">&#9670;&nbsp;</a></span>print() <span class="overload">[1/5]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#af67b36507b53221d03a5b7f1fd6638f0">&#9670;&nbsp;</a></span>print() <span class="overload">[1/4]</span></h2>

<div class="memitem">
<div class="memproto">
Expand Down Expand Up @@ -372,7 +369,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af67b36507b53221d03a5b7f1
</div>
</div>
<a id="a07c14d06d288277bbe6aa4573c21596f" name="a07c14d06d288277bbe6aa4573c21596f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07c14d06d288277bbe6aa4573c21596f">&#9670;&nbsp;</a></span>print() <span class="overload">[2/5]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#a07c14d06d288277bbe6aa4573c21596f">&#9670;&nbsp;</a></span>print() <span class="overload">[2/4]</span></h2>

<div class="memitem">
<div class="memproto">
Expand Down Expand Up @@ -429,63 +426,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#a07c14d06d288277bbe6aa457
</dd>
</dl>

</div>
</div>
<a id="a7ce5047e3cd8fa827e30a69e617ebb65" name="a7ce5047e3cd8fa827e30a69e617ebb65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ce5047e3cd8fa827e30a69e617ebb65">&#9670;&nbsp;</a></span>print() <span class="overload">[3/5]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void IO::print </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../d9/d49/types_8h.html#a338951b7e7607b65262fb051e7804d91">string</a>&#160;</td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="../../d9/d49/types_8h.html#a338951b7e7607b65262fb051e7804d91">string</a>&#160;</td>
<td class="paramname"><em>fg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="../../d9/d49/types_8h.html#a338951b7e7607b65262fb051e7804d91">string</a>&#160;</td>
<td class="paramname"><em>style</em> = <code><a class="el" href="../../dc/dac/io_8h.html#a41b83c18bcf97d8a6f1435338edc48ae">TERM_STYLE_NORMAL</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

<p>Print text to the output stream. </p>
<p >This method prints the specified text to the output stream with specified foreground color and style.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>The text to be printed. </td></tr>
<tr><td class="paramname">fg</td><td>Foreground color of the output text. </td></tr>
<tr><td class="paramname">style</td><td>Style/format of the output. </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="a60ac760446a47d3e1926ffe0120ff854" name="a60ac760446a47d3e1926ffe0120ff854"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60ac760446a47d3e1926ffe0120ff854">&#9670;&nbsp;</a></span>print() <span class="overload">[4/5]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#a60ac760446a47d3e1926ffe0120ff854">&#9670;&nbsp;</a></span>print() <span class="overload">[3/4]</span></h2>

<div class="memitem">
<div class="memproto">
Expand Down Expand Up @@ -520,7 +464,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a60ac760446a47d3e1926ffe0
</div>
</div>
<a id="a30f60dd764ba3cb47b19849297dbb7d5" name="a30f60dd764ba3cb47b19849297dbb7d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30f60dd764ba3cb47b19849297dbb7d5">&#9670;&nbsp;</a></span>print() <span class="overload">[5/5]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#a30f60dd764ba3cb47b19849297dbb7d5">&#9670;&nbsp;</a></span>print() <span class="overload">[4/4]</span></h2>

<div class="memitem">
<div class="memproto">
Expand Down
Loading

0 comments on commit 4924772

Please sign in to comment.