Skip to content

Commit

Permalink
Documentation for IO::printf(...) function on SDK.
Browse files Browse the repository at this point in the history
  • Loading branch information
nthnn committed May 18, 2024
1 parent b50f39e commit aaaefa0
Show file tree
Hide file tree
Showing 8 changed files with 410 additions and 263 deletions.
15 changes: 9 additions & 6 deletions docs/d1/d56/classIO-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,14 +99,17 @@
<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#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="even"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#addcc06b0dbaa465c2ec6bbb3edeb010e">print</a>(u64 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#a8e35325a2d94571c40a73b1d1af0e962">printf</a>(string format,...)</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>
<tr class="odd"><td class="entry"><a class="el" href="../../d8/d66/classIO.html#a274b06672ffc339ddf00e989c297058b">println</a>(u64 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>
</table></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath">
Expand Down
148 changes: 140 additions & 8 deletions docs/d8/d66/classIO.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,12 @@
<tr class="memitem:a347e2480a53d256289d8934f69424769"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d66/classIO.html#a347e2480a53d256289d8934f69424769">println</a> (<a class="el" href="../../d9/d49/types_8h.html#a6c95997324761b0f5e6aa06244f52d24">i64</a> number)</td></tr>
<tr class="memdesc:a347e2480a53d256289d8934f69424769"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print an integer number to the output stream. <a href="../../d8/d66/classIO.html#a347e2480a53d256289d8934f69424769">More...</a><br /></td></tr>
<tr class="separator:a347e2480a53d256289d8934f69424769"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addcc06b0dbaa465c2ec6bbb3edeb010e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d66/classIO.html#addcc06b0dbaa465c2ec6bbb3edeb010e">print</a> (<a class="el" href="../../d9/d49/types_8h.html#ad9a16e74d880983f276dce5b0344b8bd">u64</a> number)</td></tr>
<tr class="memdesc:addcc06b0dbaa465c2ec6bbb3edeb010e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print an unsigned number to the output stream. <a href="../../d8/d66/classIO.html#addcc06b0dbaa465c2ec6bbb3edeb010e">More...</a><br /></td></tr>
<tr class="separator:addcc06b0dbaa465c2ec6bbb3edeb010e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a274b06672ffc339ddf00e989c297058b"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d66/classIO.html#a274b06672ffc339ddf00e989c297058b">println</a> (<a class="el" href="../../d9/d49/types_8h.html#ad9a16e74d880983f276dce5b0344b8bd">u64</a> number)</td></tr>
<tr class="memdesc:a274b06672ffc339ddf00e989c297058b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print an unsigned number to the output stream. <a href="../../d8/d66/classIO.html#a274b06672ffc339ddf00e989c297058b">More...</a><br /></td></tr>
<tr class="separator:a274b06672ffc339ddf00e989c297058b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60ac760446a47d3e1926ffe0120ff854"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d66/classIO.html#a60ac760446a47d3e1926ffe0120ff854">print</a> (double number)</td></tr>
<tr class="memdesc:a60ac760446a47d3e1926ffe0120ff854"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print a floating-point number to the output stream. <a href="../../d8/d66/classIO.html#a60ac760446a47d3e1926ffe0120ff854">More...</a><br /></td></tr>
<tr class="separator:a60ac760446a47d3e1926ffe0120ff854"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand All @@ -123,6 +129,9 @@
<tr class="memitem:a39320ea206b969166668dfc24b1a40bc"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d66/classIO.html#a39320ea206b969166668dfc24b1a40bc">println</a> ()</td></tr>
<tr class="memdesc:a39320ea206b969166668dfc24b1a40bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints a new line to the output stream. <a href="../../d8/d66/classIO.html#a39320ea206b969166668dfc24b1a40bc">More...</a><br /></td></tr>
<tr class="separator:a39320ea206b969166668dfc24b1a40bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e35325a2d94571c40a73b1d1af0e962"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d66/classIO.html#a8e35325a2d94571c40a73b1d1af0e962">printf</a> (<a class="el" href="../../d9/d49/types_8h.html#a338951b7e7607b65262fb051e7804d91">string</a> format,...)</td></tr>
<tr class="memdesc:a8e35325a2d94571c40a73b1d1af0e962"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints formatted output. <a href="../../d8/d66/classIO.html#a8e35325a2d94571c40a73b1d1af0e962">More...</a><br /></td></tr>
<tr class="separator:a8e35325a2d94571c40a73b1d1af0e962"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01c3ab55c12e331ec335671be1e04aea"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="../../d9/d49/types_8h.html#a3b1df617247dbb90f86c43c7e5a0504d">i32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d66/classIO.html#a01c3ab55c12e331ec335671be1e04aea">available</a> ()</td></tr>
<tr class="memdesc:a01c3ab55c12e331ec335671be1e04aea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if there is data available to read from the input stream. <a href="../../d8/d66/classIO.html#a01c3ab55c12e331ec335671be1e04aea">More...</a><br /></td></tr>
<tr class="separator:a01c3ab55c12e331ec335671be1e04aea"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -334,7 +343,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/4]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#af67b36507b53221d03a5b7f1fd6638f0">&#9670;&nbsp;</a></span>print() <span class="overload">[1/5]</span></h2>

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

<div class="memitem">
<div class="memproto">
Expand Down Expand Up @@ -429,7 +438,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a07c14d06d288277bbe6aa457
</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">[3/4]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#a60ac760446a47d3e1926ffe0120ff854">&#9670;&nbsp;</a></span>print() <span class="overload">[3/5]</span></h2>

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

<div class="memitem">
<div class="memproto">
Expand Down Expand Up @@ -496,10 +505,98 @@ <h2 class="memtitle"><span class="permalink"><a href="#a30f60dd764ba3cb47b198492
</dd>
</dl>

</div>
</div>
<a id="addcc06b0dbaa465c2ec6bbb3edeb010e" name="addcc06b0dbaa465c2ec6bbb3edeb010e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addcc06b0dbaa465c2ec6bbb3edeb010e">&#9670;&nbsp;</a></span>print() <span class="overload">[5/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"><a class="el" href="../../d9/d49/types_8h.html#ad9a16e74d880983f276dce5b0344b8bd">u64</a>&#160;</td>
<td class="paramname"><em>number</em></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 an unsigned number to the output stream. </p>
<p >This method prints the specified unsigned number to the output stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">number</td><td>The unsigned number to be printed. </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="a8e35325a2d94571c40a73b1d1af0e962" name="a8e35325a2d94571c40a73b1d1af0e962"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e35325a2d94571c40a73b1d1af0e962">&#9670;&nbsp;</a></span>printf()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool IO::printf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d9/d49/types_8h.html#a338951b7e7607b65262fb051e7804d91">string</a>&#160;</td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#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>Prints formatted output. </p>
<p >This method prints formatted output to the standard output stream. It behaves similar to the printf function in C/C++, allowing developers to specify a format string and additional arguments for formatting.</p>
<p >Formatters:</p><ul>
<li><code>{i}</code> &mdash; Integer number value</li>
<li><code>{u}</code> &mdash; Unsigned number value</li>
<li><code>{d}</code> &mdash; Double or floating-point number</li>
<li><code>{s}</code> &mdash; String value</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>A string specifying the format of the output. </td></tr>
<tr><td class="paramname">...</td><td>Additional arguments to be formatted according to the format string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the output operation is successful, false otherwise. </dd></dl>

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

<div class="memitem">
<div class="memproto">
Expand Down Expand Up @@ -527,7 +624,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a39320ea206b969166668dfc2
</div>
</div>
<a id="a8082871c5668c9c33b240a7a554fd6d6" name="a8082871c5668c9c33b240a7a554fd6d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8082871c5668c9c33b240a7a554fd6d6">&#9670;&nbsp;</a></span>println() <span class="overload">[2/4]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#a8082871c5668c9c33b240a7a554fd6d6">&#9670;&nbsp;</a></span>println() <span class="overload">[2/5]</span></h2>

<div class="memitem">
<div class="memproto">
Expand Down Expand Up @@ -562,7 +659,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8082871c5668c9c33b240a7a
</div>
</div>
<a id="a01e030ddba974247f84b2465d9151ce4" name="a01e030ddba974247f84b2465d9151ce4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01e030ddba974247f84b2465d9151ce4">&#9670;&nbsp;</a></span>println() <span class="overload">[3/4]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#a01e030ddba974247f84b2465d9151ce4">&#9670;&nbsp;</a></span>println() <span class="overload">[3/5]</span></h2>

<div class="memitem">
<div class="memproto">
Expand Down Expand Up @@ -597,7 +694,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a01e030ddba974247f84b2465
</div>
</div>
<a id="a347e2480a53d256289d8934f69424769" name="a347e2480a53d256289d8934f69424769"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a347e2480a53d256289d8934f69424769">&#9670;&nbsp;</a></span>println() <span class="overload">[4/4]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#a347e2480a53d256289d8934f69424769">&#9670;&nbsp;</a></span>println() <span class="overload">[4/5]</span></h2>

<div class="memitem">
<div class="memproto">
Expand Down Expand Up @@ -629,6 +726,41 @@ <h2 class="memtitle"><span class="permalink"><a href="#a347e2480a53d256289d8934f
</dd>
</dl>

</div>
</div>
<a id="a274b06672ffc339ddf00e989c297058b" name="a274b06672ffc339ddf00e989c297058b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a274b06672ffc339ddf00e989c297058b">&#9670;&nbsp;</a></span>println() <span class="overload">[5/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::println </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d9/d49/types_8h.html#ad9a16e74d880983f276dce5b0344b8bd">u64</a>&#160;</td>
<td class="paramname"><em>number</em></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 an unsigned number to the output stream. </p>
<p >This method prints the specified unsigned number to the output stream followed by a new line.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">number</td><td>The unsigned number to be printed. </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="abd2fd0dfb704cad591e256cb8074f5b2" name="abd2fd0dfb704cad591e256cb8074f5b2"></a>
Expand Down
Loading

0 comments on commit aaaefa0

Please sign in to comment.