Completely reworked documentation

1 files changed, 119 insertions, 0 deletions

diff --git a/docs/html/Hall_8h_source.html b/docs/html/Hall_8h_source.html
new file mode 100644
index 0000000..6053b27
--- /dev/null
+++ b/docs/html/Hall_8h_source.html
@@ -0,0 +1,119 @@
+<!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 Ticket System: src/Models/Hall.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 Ticket System
+   </div>
+   <div id="projectbrief">| Kamen Mladenov | FMI Computer Science Year 1 Group 6 | Project 1 | Project Topic 4 |</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">Hall.h</div></div>
+</div><!--header-->
+<div class="contents">
+<a href="Hall_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 HEADER_MODEL_HALL</span></div>
+<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="preprocessor">#define HEADER_MODEL_HALL</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 &lt;istream&gt;</span></div>
+<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="preprocessor">#include &lt;ostream&gt;</span></div>
+<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span> </div>
+<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="classHall.html">   13</a></span><span class="keyword">class </span><a class="code hl_class" href="classHall.html">Hall</a> {</div>
+<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span>    <span class="keywordtype">int</span> number;</div>
+<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span>    <span class="keywordtype">unsigned</span> rows;</div>
+<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span>    <span class="keywordtype">unsigned</span> seatsPerRow;</div>
+<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span> </div>
+<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</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_function" href="classHall.html#a122ed8085be305339c89cadb3e360b86">Hall</a>();</div>
+<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span>    <a class="code hl_function" href="classHall.html#a122ed8085be305339c89cadb3e360b86">Hall</a>(<span class="keywordtype">int</span> number);</div>
+<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span>    <a class="code hl_function" href="classHall.html#a122ed8085be305339c89cadb3e360b86">Hall</a>(<span class="keywordtype">int</span> number, <span class="keywordtype">unsigned</span> rows, <span class="keywordtype">unsigned</span> seatsPerRow);</div>
+<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
+<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>    <span class="keywordtype">int</span> <a class="code hl_function" href="classHall.html#a84186aee50631f25b214f18f7b0dc178">get_number</a>() <span class="keyword">const</span>;</div>
+<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>    <span class="keywordtype">unsigned</span> <a class="code hl_function" href="classHall.html#a6b3c304a95d3f56980c6faf0cc2073a2">get_rows</a>() <span class="keyword">const</span>;</div>
+<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>    <span class="keywordtype">unsigned</span> <a class="code hl_function" href="classHall.html#a42e1cd716086d8a42a627e00cde17a7e">get_seatsPerRow</a>() <span class="keyword">const</span>;</div>
+<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</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="classHall.html#acef974f302d8131ef4608e15f96c2df9">read</a>(std::istream&amp; istr);</div>
+<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>    <span class="keywordtype">void</span> <a class="code hl_function" href="classHall.html#a0239d59ab0f832f16cf35c820d0eba5a">write</a>(std::ostream&amp; ostr) <span class="keyword">const</span>;</div>
+<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>    <span class="keywordtype">int</span> <a class="code hl_function" href="classHall.html#a4259837f943c488c6b15ed6c80d5f30b">compare</a>(<span class="keyword">const</span> <a class="code hl_class" href="classHall.html">Hall</a>&amp; other) <span class="keyword">const</span>;</div>
+<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span> </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>std::istream&amp; <a class="code hl_function" href="Hall_8h.html#ac55d9db507637effdb1896e33c86d439">operator&gt;&gt;</a>(std::istream&amp; istr, <a class="code hl_class" href="classHall.html">Hall</a>&amp; hall);</div>
+<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>std::ostream&amp; <a class="code hl_function" href="Hall_8h.html#a9671d0935caa6dd24b5f1b9be101c477">operator&lt;&lt;</a>(std::ostream&amp; ostr, <span class="keyword">const</span> <a class="code hl_class" href="classHall.html">Hall</a>&amp; hall);</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><span class="preprocessor">#endif</span></div>
+<div class="ttc" id="aHall_8h_html_a9671d0935caa6dd24b5f1b9be101c477"><div class="ttname"><a href="Hall_8h.html#a9671d0935caa6dd24b5f1b9be101c477">operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;ostr, const Hall &amp;hall)</div><div class="ttdoc">Writes Hall to stream with &lt;&lt; operator.</div><div class="ttdef"><b>Definition:</b> Hall.cpp:74</div></div>
+<div class="ttc" id="aHall_8h_html_ac55d9db507637effdb1896e33c86d439"><div class="ttname"><a href="Hall_8h.html#ac55d9db507637effdb1896e33c86d439">operator&gt;&gt;</a></div><div class="ttdeci">std::istream &amp; operator&gt;&gt;(std::istream &amp;istr, Hall &amp;hall)</div><div class="ttdoc">Reads Hall from stream with &gt;&gt; operator.</div><div class="ttdef"><b>Definition:</b> Hall.cpp:61</div></div>
+<div class="ttc" id="aclassHall_html"><div class="ttname"><a href="classHall.html">Hall</a></div><div class="ttdoc">Each hall contains a number, rows and seats per row.</div><div class="ttdef"><b>Definition:</b> Hall.h:13</div></div>
+<div class="ttc" id="aclassHall_html_a0239d59ab0f832f16cf35c820d0eba5a"><div class="ttname"><a href="classHall.html#a0239d59ab0f832f16cf35c820d0eba5a">Hall::write</a></div><div class="ttdeci">void write(std::ostream &amp;ostr) const</div><div class="ttdoc">Writes Hall to steam.</div><div class="ttdef"><b>Definition:</b> Hall.cpp:44</div></div>
+<div class="ttc" id="aclassHall_html_a122ed8085be305339c89cadb3e360b86"><div class="ttname"><a href="classHall.html#a122ed8085be305339c89cadb3e360b86">Hall::Hall</a></div><div class="ttdeci">Hall()</div><div class="ttdoc">Sets values to 0.</div><div class="ttdef"><b>Definition:</b> Hall.cpp:3</div></div>
+<div class="ttc" id="aclassHall_html_a4259837f943c488c6b15ed6c80d5f30b"><div class="ttname"><a href="classHall.html#a4259837f943c488c6b15ed6c80d5f30b">Hall::compare</a></div><div class="ttdeci">int compare(const Hall &amp;other) const</div><div class="ttdoc">Compare two Halls.</div><div class="ttdef"><b>Definition:</b> Hall.cpp:52</div></div>
+<div class="ttc" id="aclassHall_html_a42e1cd716086d8a42a627e00cde17a7e"><div class="ttname"><a href="classHall.html#a42e1cd716086d8a42a627e00cde17a7e">Hall::get_seatsPerRow</a></div><div class="ttdeci">unsigned get_seatsPerRow() const</div><div class="ttdoc">Return a Hall's seats per row count.</div><div class="ttdef"><b>Definition:</b> Hall.cpp:20</div></div>
+<div class="ttc" id="aclassHall_html_a6b3c304a95d3f56980c6faf0cc2073a2"><div class="ttname"><a href="classHall.html#a6b3c304a95d3f56980c6faf0cc2073a2">Hall::get_rows</a></div><div class="ttdeci">unsigned get_rows() const</div><div class="ttdoc">Returns a Hall's row count.</div><div class="ttdef"><b>Definition:</b> Hall.cpp:16</div></div>
+<div class="ttc" id="aclassHall_html_a84186aee50631f25b214f18f7b0dc178"><div class="ttname"><a href="classHall.html#a84186aee50631f25b214f18f7b0dc178">Hall::get_number</a></div><div class="ttdeci">int get_number() const</div><div class="ttdoc">Returns a Hall's number.</div><div class="ttdef"><b>Definition:</b> Hall.cpp:13</div></div>
+<div class="ttc" id="aclassHall_html_acef974f302d8131ef4608e15f96c2df9"><div class="ttname"><a href="classHall.html#acef974f302d8131ef4608e15f96c2df9">Hall::read</a></div><div class="ttdeci">void read(std::istream &amp;istr)</div><div class="ttdoc">Reads Hall from stream.</div><div class="ttdef"><b>Definition:</b> Hall.cpp:31</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>