Skip to content

Commit

Permalink
Added doxygen documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@kikoveiga
kikoveiga committed Jun 5, 2023
1 parent c02dafe commit 90ecbed
Show file tree
Hide file tree
Showing 138 changed files with 10,498 additions and 0 deletions.
244 changes: 244 additions & 0 deletions html/_graph_8h_source.html
View file

Large diffs are not rendered by default.

161 changes: 161 additions & 0 deletions html/_menu_8h_source.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
<!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=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DA2: headers/Menu.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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">DA2
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_menu_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">Menu.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Created by kikoveiga on 03-05-2023.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#ifndef DA2_MENU_H</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#define DA2_MENU_H</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;Utils.h&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;iostream&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;algorithm&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;iomanip&gt;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;chrono&gt;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="class_menu.html"> 14</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_menu.html">Menu</a> {</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <a class="code" href="class_utils.html">Utils</a> utils;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; std::string command;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <a class="code" href="class_menu.html#ad466dd83355124a6ed958430450bfe94">Menu</a>();</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_menu.html#a35656cd130e24d69383a5c9d0a73a38c">run</a>();</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_menu.html#ac25314c3cd77b28236df48494093cc80">cleanTerminal</a>();</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_menu.html#a4711ed81dcc5bcdee67482f95ce81efc">enterOption</a>(<span class="keywordtype">unsigned</span> n);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_menu.html#a84b74cccf815470992a7b04897121ade">press0ToContinue</a>();</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_menu.html#aef9edee86d2ea460606361c92e061583">mainMenu</a>();</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_menu.html#aa8abfffc35c9c3b24ac1bbf7e1a29c53">graphsMenu</a>();</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_menu.html#a952403a7d53111e4e062fcfcb44bd02b">graphMenu</a>(<a class="code" href="class_graph.html">Graph</a>* graph);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_menu.html#a9e06044a340dfa80baf4df6ab313e84e">printGraph</a>(<a class="code" href="class_graph.html">Graph</a>* graph);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_menu.html#a7d9a564c7b275c67ffef3032ed7b8ef4">algorithmsMenu</a>();</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_menu.html#a88e0390c3e57f4ace4765f8a70ef2da0">tSPGameMenu</a>();</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_menu.html#ac6dbba79dcddf07cb18c9fcb8af8c997">tSPGame</a>(<a class="code" href="class_graph.html">Graph</a>* graph);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;};</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="preprocessor">#endif </span><span class="comment">//DA2_MENU_H</span></div>
<div class="ttc" id="aclass_graph_html"><div class="ttname"><a href="class_graph.html">Graph</a></div><div class="ttdef"><b>Definition:</b> Graph.h:17</div></div>
<div class="ttc" id="aclass_menu_html"><div class="ttname"><a href="class_menu.html">Menu</a></div><div class="ttdef"><b>Definition:</b> Menu.h:14</div></div>
<div class="ttc" id="aclass_menu_html_a35656cd130e24d69383a5c9d0a73a38c"><div class="ttname"><a href="class_menu.html#a35656cd130e24d69383a5c9d0a73a38c">Menu::run</a></div><div class="ttdeci">void run()</div><div class="ttdoc">Function designed to run the different menus.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:18</div></div>
<div class="ttc" id="aclass_menu_html_a4711ed81dcc5bcdee67482f95ce81efc"><div class="ttname"><a href="class_menu.html#a4711ed81dcc5bcdee67482f95ce81efc">Menu::enterOption</a></div><div class="ttdeci">void enterOption(unsigned n)</div><div class="ttdoc">Function designed to choose an option in the menus.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:55</div></div>
<div class="ttc" id="aclass_menu_html_a7d9a564c7b275c67ffef3032ed7b8ef4"><div class="ttname"><a href="class_menu.html#a7d9a564c7b275c67ffef3032ed7b8ef4">Menu::algorithmsMenu</a></div><div class="ttdeci">void algorithmsMenu()</div><div class="ttdoc">Function that runs and prints the algorithms menu.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:203</div></div>
<div class="ttc" id="aclass_menu_html_a84b74cccf815470992a7b04897121ade"><div class="ttname"><a href="class_menu.html#a84b74cccf815470992a7b04897121ade">Menu::press0ToContinue</a></div><div class="ttdeci">void press0ToContinue()</div><div class="ttdoc">Function designed to ask the user to continue by pressing 0.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:65</div></div>
<div class="ttc" id="aclass_menu_html_a88e0390c3e57f4ace4765f8a70ef2da0"><div class="ttname"><a href="class_menu.html#a88e0390c3e57f4ace4765f8a70ef2da0">Menu::tSPGameMenu</a></div><div class="ttdeci">void tSPGameMenu()</div><div class="ttdoc">Function that runs and prints a little TSP game menu.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:522</div></div>
<div class="ttc" id="aclass_menu_html_a952403a7d53111e4e062fcfcb44bd02b"><div class="ttname"><a href="class_menu.html#a952403a7d53111e4e062fcfcb44bd02b">Menu::graphMenu</a></div><div class="ttdeci">void graphMenu(Graph *graph)</div><div class="ttdoc">Function that runs and prints a certain graph menu.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:128</div></div>
<div class="ttc" id="aclass_menu_html_a9e06044a340dfa80baf4df6ab313e84e"><div class="ttname"><a href="class_menu.html#a9e06044a340dfa80baf4df6ab313e84e">Menu::printGraph</a></div><div class="ttdeci">static void printGraph(Graph *graph)</div><div class="ttdoc">Function that prints a graph to a text file.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:176</div></div>
<div class="ttc" id="aclass_menu_html_aa8abfffc35c9c3b24ac1bbf7e1a29c53"><div class="ttname"><a href="class_menu.html#aa8abfffc35c9c3b24ac1bbf7e1a29c53">Menu::graphsMenu</a></div><div class="ttdeci">void graphsMenu()</div><div class="ttdoc">Function that runs and prints the graphs menu.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:88</div></div>
<div class="ttc" id="aclass_menu_html_ac25314c3cd77b28236df48494093cc80"><div class="ttname"><a href="class_menu.html#ac25314c3cd77b28236df48494093cc80">Menu::cleanTerminal</a></div><div class="ttdeci">static void cleanTerminal()</div><div class="ttdoc">Function that cleans the terminal.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:51</div></div>
<div class="ttc" id="aclass_menu_html_ac6dbba79dcddf07cb18c9fcb8af8c997"><div class="ttname"><a href="class_menu.html#ac6dbba79dcddf07cb18c9fcb8af8c997">Menu::tSPGame</a></div><div class="ttdeci">void tSPGame(Graph *graph)</div><div class="ttdoc">Function that runs and prints the TSP game.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:553</div></div>
<div class="ttc" id="aclass_menu_html_ad466dd83355124a6ed958430450bfe94"><div class="ttname"><a href="class_menu.html#ad466dd83355124a6ed958430450bfe94">Menu::Menu</a></div><div class="ttdeci">Menu()</div><div class="ttdoc">Menu constructor that initializes the command and calls the run function.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:13</div></div>
<div class="ttc" id="aclass_menu_html_aef9edee86d2ea460606361c92e061583"><div class="ttname"><a href="class_menu.html#aef9edee86d2ea460606361c92e061583">Menu::mainMenu</a></div><div class="ttdeci">void mainMenu()</div><div class="ttdoc">Function that runs and prints the main menu.</div><div class="ttdef"><b>Definition:</b> Menu.cpp:73</div></div>
<div class="ttc" id="aclass_utils_html"><div class="ttname"><a href="class_utils.html">Utils</a></div><div class="ttdef"><b>Definition:</b> Utils.h:14</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_7f57b1e41c5acd0e859ae5f3a2b075a9.html">headers</a></li><li class="navelem"><b>Menu.h</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
Loading

0 comments on commit 90ecbed

Please sign in to comment.