Completely reworked documentation

1 files changed, 114 insertions, 0 deletions

diff --git a/docs/html/Ticket_8h_source.html b/docs/html/Ticket_8h_source.html
new file mode 100644
index 0000000..1d9c133
--- /dev/null
+++ b/docs/html/Ticket_8h_source.html
@@ -0,0 +1,114 @@
+<!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/Ticket.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">Ticket.h</div></div>
+</div><!--header-->
+<div class="contents">
+<a href="Ticket_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_HEADER_TICKET</span></div>
+<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="preprocessor">#define HEADER_HEADER_TICKET</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="classTicket.html">   13</a></span><span class="keyword">class </span><a class="code hl_class" href="classTicket.html">Ticket</a> {</div>
+<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span>    <span class="keywordtype">unsigned</span> row;</div>
+<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span>    <span class="keywordtype">unsigned</span> seat;</div>
+<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span> </div>
+<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="keyword">public</span>:</div>
+<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span>    <a class="code hl_function" href="classTicket.html#aba3a46c9223efb6ab0bde93a09403537">Ticket</a>();</div>
+<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span>    <a class="code hl_function" href="classTicket.html#aba3a46c9223efb6ab0bde93a09403537">Ticket</a>(<span class="keywordtype">unsigned</span> row, <span class="keywordtype">unsigned</span> seat);</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="classTicket.html#a94476de3cd6711185527d0fe4df9a278">get_row</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="classTicket.html#af7b64cb77a676d0f7bdb32255283f005">get_seat</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="classTicket.html#aad2d0b7b92b54ec861db92c31f50f4ad">read</a>(std::istream&amp; istr);</div>
+<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>    <span class="keywordtype">void</span> <a class="code hl_function" href="classTicket.html#a584a11f6236fc96f3bdbd0592d3f60f4">write</a>(std::ostream&amp; ostr) <span class="keyword">const</span>;</div>
+<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>    <span class="keywordtype">int</span> <a class="code hl_function" href="classTicket.html#a82a063f71be89f44dd969970855187c4">compare</a>(<span class="keyword">const</span> <a class="code hl_class" href="classTicket.html">Ticket</a>&amp; other) <span class="keyword">const</span>;</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>std::istream&amp; <a class="code hl_function" href="Ticket_8h.html#ac5c53ae039e173faa4cce85c2e32c920">operator&gt;&gt;</a>(std::istream&amp; istr, <a class="code hl_class" href="classTicket.html">Ticket</a>&amp; ticket);</div>
+<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>std::ostream&amp; <a class="code hl_function" href="Ticket_8h.html#ae1686d3505df5e86e64e6e1b263e92ce">operator&lt;&lt;</a>(std::ostream&amp; ostr, <span class="keyword">const</span> <a class="code hl_class" href="classTicket.html">Ticket</a>&amp; ticket);</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><span class="preprocessor">#endif</span></div>
+<div class="ttc" id="aTicket_8h_html_ac5c53ae039e173faa4cce85c2e32c920"><div class="ttname"><a href="Ticket_8h.html#ac5c53ae039e173faa4cce85c2e32c920">operator&gt;&gt;</a></div><div class="ttdeci">std::istream &amp; operator&gt;&gt;(std::istream &amp;istr, Ticket &amp;ticket)</div><div class="ttdoc">Reads Ticket from stream with &gt;&gt; operator.</div><div class="ttdef"><b>Definition:</b> Ticket.cpp:57</div></div>
+<div class="ttc" id="aTicket_8h_html_ae1686d3505df5e86e64e6e1b263e92ce"><div class="ttname"><a href="Ticket_8h.html#ae1686d3505df5e86e64e6e1b263e92ce">operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;ostr, const Ticket &amp;ticket)</div><div class="ttdoc">Writes Ticket to stream with &lt;&lt; operator.</div><div class="ttdef"><b>Definition:</b> Ticket.cpp:69</div></div>
+<div class="ttc" id="aclassTicket_html"><div class="ttname"><a href="classTicket.html">Ticket</a></div><div class="ttdoc">Each Ticket contains a row and a seat number.</div><div class="ttdef"><b>Definition:</b> Ticket.h:13</div></div>
+<div class="ttc" id="aclassTicket_html_a584a11f6236fc96f3bdbd0592d3f60f4"><div class="ttname"><a href="classTicket.html#a584a11f6236fc96f3bdbd0592d3f60f4">Ticket::write</a></div><div class="ttdeci">void write(std::ostream &amp;ostr) const</div><div class="ttdoc">Writes Ticket to stream.</div><div class="ttdef"><b>Definition:</b> Ticket.cpp:37</div></div>
+<div class="ttc" id="aclassTicket_html_a82a063f71be89f44dd969970855187c4"><div class="ttname"><a href="classTicket.html#a82a063f71be89f44dd969970855187c4">Ticket::compare</a></div><div class="ttdeci">int compare(const Ticket &amp;other) const</div><div class="ttdoc">Compares two Tickets.</div><div class="ttdef"><b>Definition:</b> Ticket.cpp:44</div></div>
+<div class="ttc" id="aclassTicket_html_a94476de3cd6711185527d0fe4df9a278"><div class="ttname"><a href="classTicket.html#a94476de3cd6711185527d0fe4df9a278">Ticket::get_row</a></div><div class="ttdeci">unsigned get_row() const</div><div class="ttdoc">Returns row.</div><div class="ttdef"><b>Definition:</b> Ticket.cpp:10</div></div>
+<div class="ttc" id="aclassTicket_html_aad2d0b7b92b54ec861db92c31f50f4ad"><div class="ttname"><a href="classTicket.html#aad2d0b7b92b54ec861db92c31f50f4ad">Ticket::read</a></div><div class="ttdeci">void read(std::istream &amp;istr)</div><div class="ttdoc">Reads Ticket from stram.</div><div class="ttdef"><b>Definition:</b> Ticket.cpp:25</div></div>
+<div class="ttc" id="aclassTicket_html_aba3a46c9223efb6ab0bde93a09403537"><div class="ttname"><a href="classTicket.html#aba3a46c9223efb6ab0bde93a09403537">Ticket::Ticket</a></div><div class="ttdeci">Ticket()</div><div class="ttdoc">Sets row and seat to zeroes.</div><div class="ttdef"><b>Definition:</b> Ticket.cpp:3</div></div>
+<div class="ttc" id="aclassTicket_html_af7b64cb77a676d0f7bdb32255283f005"><div class="ttname"><a href="classTicket.html#af7b64cb77a676d0f7bdb32255283f005">Ticket::get_seat</a></div><div class="ttdeci">unsigned get_seat() const</div><div class="ttdoc">Returns seat.</div><div class="ttdef"><b>Definition:</b> Ticket.cpp:14</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>