Added documentation

1 files changed, 113 insertions, 0 deletions

diff --git a/docs/html/Table_8h_source.html b/docs/html/Table_8h_source.html
new file mode 100644
index 0000000..ff3311a
--- /dev/null
+++ b/docs/html/Table_8h_source.html
@@ -0,0 +1,113 @@
+<!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/Models/Table.h 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_36df885461d6bd14211edf06510d126c.html">Models</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="headertitle"><div class="title">Table.h</div></div>
+</div><!--header-->
+<div class="contents">
+<a href="Table_8h.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 MODELS_TABLE</span></div>
+<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="preprocessor">#define MODELS_TABLE</span></div>
+<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span> </div>
+<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#include &quot;<a class="code" href="Cell_8h.html">Cell.h</a>&quot;</span></div>
+<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="preprocessor">#include &quot;../Generic/List/List.hpp&quot;</span></div>
+<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#include &lt;fstream&gt;</span></div>
+<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span> </div>
+<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classTable.html">   14</a></span><span class="keyword">class </span><a class="code hl_class" href="classTable.html">Table</a> {</div>
+<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span>    <a class="code hl_class" href="classList.html">List&lt;List&lt;Cell*&gt;</a>&gt; cells;</div>
+<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span>    <span class="keywordtype">unsigned</span> longestRow;</div>
+<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span>    <span class="keywordtype">void</span> readFromFile(std::ifstream&amp; inFile);</div>
+<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span> </div>
+<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="keyword">public</span>:</div>
+<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span>    <a class="code hl_class" href="classTable.html">Table</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* filePath);</div>
+<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span>    <a class="code hl_class" href="classTable.html">~Table</a>();</div>
+<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span> </div>
+<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span>    <span class="keywordtype">unsigned</span> <a class="code hl_function" href="classTable.html#a8d2cec43247d091c9b2eb82fadc1a40b">get_rows</a>() <span class="keyword">const</span>;</div>
+<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span>    <span class="keywordtype">unsigned</span> <a class="code hl_function" href="classTable.html#af6dce3e4e7be8c073cef6b1a6876d41d">get_cols</a>() <span class="keyword">const</span>;</div>
+<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
+<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>    <span class="keywordtype">void</span> <a class="code hl_function" href="classTable.html#a83388586d16c5b42029298b72ed698a5">putCell</a>(<span class="keywordtype">unsigned</span> row, <span class="keywordtype">unsigned</span> col, <span class="keyword">const</span> <span class="keywordtype">char</span>* rawValue);</div>
+<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span> </div>
+<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>    <a class="code hl_class" href="classList.html">List&lt;String&gt;</a> <a class="code hl_function" href="classTable.html#a654a6b6617a91dc96dde9038220967d8">getAllCells</a>() <span class="keyword">const</span>;</div>
+<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>    <span class="keywordtype">void</span> <a class="code hl_function" href="classTable.html#a8a29a5f941369c8b61c56b4d6507a9fa">saveToFile</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* filePath) <span class="keyword">const</span>;</div>
+<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>};</div>
+<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span> </div>
+<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="preprocessor">#endif</span></div>
+<div class="ttc" id="aCell_8h_html"><div class="ttname"><a href="Cell_8h.html">Cell.h</a></div><div class="ttdoc">Stores the declaration of class Cell.</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 class="ttc" id="aclassTable_html"><div class="ttname"><a href="classTable.html">Table</a></div><div class="ttdoc">A 2D collection of Cell instances.</div><div class="ttdef"><b>Definition:</b> Table.h:14</div></div>
+<div class="ttc" id="aclassTable_html_a654a6b6617a91dc96dde9038220967d8"><div class="ttname"><a href="classTable.html#a654a6b6617a91dc96dde9038220967d8">Table::getAllCells</a></div><div class="ttdeci">List&lt; String &gt; getAllCells() const</div><div class="ttdoc">Returns a List of String with String representation of every cell in order.</div><div class="ttdef"><b>Definition:</b> Table.cpp:191</div></div>
+<div class="ttc" id="aclassTable_html_a83388586d16c5b42029298b72ed698a5"><div class="ttname"><a href="classTable.html#a83388586d16c5b42029298b72ed698a5">Table::putCell</a></div><div class="ttdeci">void putCell(unsigned row, unsigned col, const char *rawValue)</div><div class="ttdoc">Parses rawValue and replaces the value at row and col with it.</div><div class="ttdef"><b>Definition:</b> Table.cpp:148</div></div>
+<div class="ttc" id="aclassTable_html_a8a29a5f941369c8b61c56b4d6507a9fa"><div class="ttname"><a href="classTable.html#a8a29a5f941369c8b61c56b4d6507a9fa">Table::saveToFile</a></div><div class="ttdeci">void saveToFile(const char *filePath) const</div><div class="ttdoc">Saves all cells to a text file.</div><div class="ttdef"><b>Definition:</b> Table.cpp:204</div></div>
+<div class="ttc" id="aclassTable_html_a8d2cec43247d091c9b2eb82fadc1a40b"><div class="ttname"><a href="classTable.html#a8d2cec43247d091c9b2eb82fadc1a40b">Table::get_rows</a></div><div class="ttdeci">unsigned get_rows() const</div><div class="ttdoc">Returns count of rows.</div><div class="ttdef"><b>Definition:</b> Table.cpp:137</div></div>
+<div class="ttc" id="aclassTable_html_af6dce3e4e7be8c073cef6b1a6876d41d"><div class="ttname"><a href="classTable.html#af6dce3e4e7be8c073cef6b1a6876d41d">Table::get_cols</a></div><div class="ttdeci">unsigned get_cols() const</div><div class="ttdoc">Returns largest count of columns in all rows.</div><div class="ttdef"><b>Definition:</b> Table.cpp:141</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>