Added documentation

1 files changed, 129 insertions, 0 deletions

diff --git a/docs/html/Toolbox_8hpp_source.html b/docs/html/Toolbox_8hpp_source.html
new file mode 100644
index 0000000..78ffde7
--- /dev/null
+++ b/docs/html/Toolbox_8hpp_source.html
@@ -0,0 +1,129 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=11"/>
+<meta name="generator" content="Doxygen 1.9.3"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>FMI Table: src/Generic/ConsoleInterface/Toolbox.hpp Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr id="projectrow">
+  <td id="projectalign">
+   <div id="projectname">FMI Table
+   </div>
+   <div id="projectbrief">| Kamen Mladenov | FMI Computer Science Year 1 Group 6 | Project 2 | Project Topic 7 |</div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.9.3 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+var searchBox = new SearchBox("searchBox", "search",'Search','.html');
+/* @license-end */
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+/* @license-end */
+</script>
+<div id="main-nav"></div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div id="nav-path" class="navpath">
+  <ul>
+<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b37d33ceb7f5c107fb027d4db224bc89.html">Generic</a></li><li class="navelem"><a class="el" href="dir_d8d09372644efb2ea8af4d02a2b08c8b.html">ConsoleInterface</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="headertitle"><div class="title">Toolbox.hpp</div></div>
+</div><!--header-->
+<div class="contents">
+<a href="Toolbox_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="preprocessor">#ifndef HEADER_CONSOLEINTERFACE_TOOLBOX</span></div>
+<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="preprocessor">#define HEADER_CONSOLEINTERFACE_TOOLBOX</span></div>
+<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span> </div>
+<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="preprocessor">#include &lt;iostream&gt;</span></div>
+<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="preprocessor">#include &quot;../List/List.hpp&quot;</span></div>
+<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="preprocessor">#include &quot;../String/String.h&quot;</span></div>
+<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span> </div>
+<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="preprocessor">#define MAX_LINE_WIDTH 1024</span></div>
+<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span> </div>
+<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="keywordtype">void</span> <a class="code hl_function" href="Toolbox_8hpp.html#a65477b86cd99f1670bf1234960255baf">inputLineBox</a>(<span class="keywordtype">char</span>* output, <span class="keywordtype">unsigned</span> maxWidth, <span class="keywordtype">bool</span> ignore = <span class="keyword">true</span>);</div>
+<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
+<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="keywordtype">void</span> <a class="code hl_function" href="Toolbox_8hpp.html#a138328aaa20f2a8a514e4d7e6fc9c325">printTable</a>(<span class="keyword">const</span> <a class="code hl_class" href="classList.html">List&lt;String&gt;</a>&amp; items, <span class="keywordtype">unsigned</span> columns);</div>
+<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span> </div>
+<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
+<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="Toolbox_8hpp.html#a3c9098dc2b305107367c56ded5dec787">   26</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="Toolbox_8hpp.html#a3c9098dc2b305107367c56ded5dec787">read</a>(T* storage) {</div>
+<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>    std::cin &gt;&gt; storage;</div>
+<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>}</div>
+<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span> </div>
+<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
+<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="Toolbox_8hpp.html#a06ca09434be2a02543a2371d477acfa0">   32</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="Toolbox_8hpp.html#a3c9098dc2b305107367c56ded5dec787">read</a>(T&amp; storage) {</div>
+<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>    std::cin &gt;&gt; storage;</div>
+<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>}</div>
+<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span> </div>
+<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
+<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="Toolbox_8hpp.html#a5ca1093462d3266fceb8522e144c1e73">   38</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="Toolbox_8hpp.html#a5ca1093462d3266fceb8522e144c1e73">print</a>(<span class="keyword">const</span> T* item) {</div>
+<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>    std::cout &lt;&lt; item;</div>
+<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>}</div>
+<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span> </div>
+<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
+<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="Toolbox_8hpp.html#a9c0a0d7d3210ca5f12f02ac4cb88476e">   44</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="Toolbox_8hpp.html#a5ca1093462d3266fceb8522e144c1e73">print</a>(<span class="keyword">const</span> T&amp; item) {</div>
+<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>    std::cout &lt;&lt; item;</div>
+<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>}</div>
+<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span> </div>
+<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
+<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="Toolbox_8hpp.html#a148d9d6b8b15bbfc2b1f4cdb16c2ee81">   50</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="Toolbox_8hpp.html#a148d9d6b8b15bbfc2b1f4cdb16c2ee81">printLine</a>(<span class="keyword">const</span> T* item) {</div>
+<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>    std::cout &lt;&lt; item &lt;&lt; std::endl;</div>
+<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>}</div>
+<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span> </div>
+<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
+<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="Toolbox_8hpp.html#a799f4cb5b4da3d40261e25d9e41995aa">   56</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="Toolbox_8hpp.html#a148d9d6b8b15bbfc2b1f4cdb16c2ee81">printLine</a>(<span class="keyword">const</span> T&amp; item) {</div>
+<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>    std::cout &lt;&lt; item &lt;&lt; std::endl;</div>
+<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>}</div>
+<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span> </div>
+<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="preprocessor">#endif</span></div>
+<div class="ttc" id="aToolbox_8hpp_html_a138328aaa20f2a8a514e4d7e6fc9c325"><div class="ttname"><a href="Toolbox_8hpp.html#a138328aaa20f2a8a514e4d7e6fc9c325">printTable</a></div><div class="ttdeci">void printTable(const List&lt; String &gt; &amp;items, unsigned columns)</div><div class="ttdoc">Prints a string list as a table.</div><div class="ttdef"><b>Definition:</b> Toolbox.cpp:66</div></div>
+<div class="ttc" id="aToolbox_8hpp_html_a148d9d6b8b15bbfc2b1f4cdb16c2ee81"><div class="ttname"><a href="Toolbox_8hpp.html#a148d9d6b8b15bbfc2b1f4cdb16c2ee81">printLine</a></div><div class="ttdeci">void printLine(const T *item)</div><div class="ttdoc">Prints given item and an endline character.</div><div class="ttdef"><b>Definition:</b> Toolbox.hpp:50</div></div>
+<div class="ttc" id="aToolbox_8hpp_html_a3c9098dc2b305107367c56ded5dec787"><div class="ttname"><a href="Toolbox_8hpp.html#a3c9098dc2b305107367c56ded5dec787">read</a></div><div class="ttdeci">void read(T *storage)</div><div class="ttdoc">Reads user input and stores it.</div><div class="ttdef"><b>Definition:</b> Toolbox.hpp:26</div></div>
+<div class="ttc" id="aToolbox_8hpp_html_a5ca1093462d3266fceb8522e144c1e73"><div class="ttname"><a href="Toolbox_8hpp.html#a5ca1093462d3266fceb8522e144c1e73">print</a></div><div class="ttdeci">void print(const T *item)</div><div class="ttdoc">Prints given item.</div><div class="ttdef"><b>Definition:</b> Toolbox.hpp:38</div></div>
+<div class="ttc" id="aToolbox_8hpp_html_a65477b86cd99f1670bf1234960255baf"><div class="ttname"><a href="Toolbox_8hpp.html#a65477b86cd99f1670bf1234960255baf">inputLineBox</a></div><div class="ttdeci">void inputLineBox(char *output, unsigned maxWidth, bool ignore=true)</div><div class="ttdoc">Prints label, gets a whole line of input and stores it to output.</div><div class="ttdef"><b>Definition:</b> Toolbox.cpp:19</div></div>
+<div class="ttc" id="aclassList_html"><div class="ttname"><a href="classList.html">List</a></div><div class="ttdoc">Templated class that stores an array of elements in dynamic memory.</div><div class="ttdef"><b>Definition:</b> List.hpp:22</div></div>
+</div><!-- fragment --></div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
+</small></address>
+</body>
+</html>