Skip to content

Commit 3709d10

Browse files
SemoMohSemoMoh
committed
feat: add documentation files for TINY::SCANNER
1 parent 6fdae0a commit 3709d10

File tree

205 files changed

+16198
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

205 files changed

+16198
-0
lines changed

‎scanner/docs/html/a00002.html

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.8"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Tiny Scanner: scanner/include/app.hpp File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="resize.js"></script>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
17+
<script type="text/javascript" src="search/searchdata.js"></script>
18+
<script type="text/javascript" src="search/search.js"></script>
19+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
20+
</head>
21+
<body>
22+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
23+
<div id="titlearea">
24+
<table cellspacing="0" cellpadding="0">
25+
<tbody>
26+
<tr id="projectrow">
27+
<td id="projectalign">
28+
<div id="projectname">Tiny Scanner
29+
</div>
30+
</td>
31+
</tr>
32+
</tbody>
33+
</table>
34+
</div>
35+
<!-- end header part -->
36+
<!-- Generated by Doxygen 1.9.8 -->
37+
<script type="text/javascript">
38+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
39+
var searchBox = new SearchBox("searchBox", "search/",'.html');
40+
/* @license-end */
41+
</script>
42+
<script type="text/javascript" src="menudata.js"></script>
43+
<script type="text/javascript" src="menu.js"></script>
44+
<script type="text/javascript">
45+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
46+
$(function() {
47+
initMenu('',true,false,'search.php','Search');
48+
$(document).ready(function() { init_search(); });
49+
});
50+
/* @license-end */
51+
</script>
52+
<div id="main-nav"></div>
53+
</div><!-- top -->
54+
<div id="side-nav" class="ui-resizable side-nav-resizable">
55+
<div id="nav-tree">
56+
<div id="nav-tree-contents">
57+
<div id="nav-sync" class="sync"></div>
58+
</div>
59+
</div>
60+
<div id="splitbar" style="-moz-user-select:none;"
61+
class="ui-resizable-handle">
62+
</div>
63+
</div>
64+
<script type="text/javascript">
65+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
66+
$(document).ready(function(){initNavTree('a00002.html',''); initResizable(); });
67+
/* @license-end */
68+
</script>
69+
<div id="doc-content">
70+
<!-- window showing the filter options -->
71+
<div id="MSearchSelectWindow"
72+
onmouseover="return searchBox.OnSearchSelectShow()"
73+
onmouseout="return searchBox.OnSearchSelectHide()"
74+
onkeydown="return searchBox.OnSearchSelectKey(event)">
75+
</div>
76+
77+
<!-- iframe showing the search results (closed by default) -->
78+
<div id="MSearchResultsWindow">
79+
<div id="MSearchResults">
80+
<div class="SRPage">
81+
<div id="SRIndex">
82+
<div id="SRResults"></div>
83+
<div class="SRStatus" id="Loading">Loading...</div>
84+
<div class="SRStatus" id="Searching">Searching...</div>
85+
<div class="SRStatus" id="NoMatches">No Matches</div>
86+
</div>
87+
</div>
88+
</div>
89+
</div>
90+
91+
<div class="header">
92+
<div class="summary">
93+
<a href="#nested-classes">Classes</a> &#124;
94+
<a href="#namespaces">Namespaces</a> &#124;
95+
<a href="#var-members">Variables</a> </div>
96+
<div class="headertitle"><div class="title">app.hpp File Reference</div></div>
97+
</div><!--header-->
98+
<div class="contents">
99+
100+
<p>This file defines the App class, which manages the execution of the application.
101+
<a href="#details">More...</a></p>
102+
<div class="textblock"><code>#include &lt;getopt.h&gt;</code><br />
103+
<code>#include &lt;iostream&gt;</code><br />
104+
<code>#include &lt;stdexcept&gt;</code><br />
105+
<code>#include &lt;string&gt;</code><br />
106+
<code>#include &lt;vector&gt;</code><br />
107+
<code>#include &quot;<a class="el" href="a00005_source.html">file_handler.hpp</a>&quot;</code><br />
108+
<code>#include &quot;<a class="el" href="a00008_source.html">scanner.hpp</a>&quot;</code><br />
109+
<code>#include &quot;<a class="el" href="a00011_source.html">token.hpp</a>&quot;</code><br />
110+
<code>#include &quot;token_stream_builder.hpp&quot;</code><br />
111+
</div>
112+
<p><a href="a00002_source.html">Go to the source code of this file.</a></p>
113+
<table class="memberdecls">
114+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
115+
Classes</h2></td></tr>
116+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00863.html">TINY::SCANNER::App</a></td></tr>
117+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Manages the execution of the application. <a href="a00863.html#details">More...</a><br /></td></tr>
118+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
119+
</table><table class="memberdecls">
120+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
121+
Namespaces</h2></td></tr>
122+
<tr class="memitem:a00045" id="r_a00045"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html">TINY</a></td></tr>
123+
<tr class="memdesc:a00045"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains all components of the <a class="el" href="a00045.html" title="Contains all components of the TINY language scanner.">TINY</a> language scanner. <br /></td></tr>
124+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
125+
<tr class="memitem:a00046" id="r_a00046"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html">SCANNER</a></td></tr>
126+
<tr class="memdesc:a00046"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains all components related to the lexical analysis (scanning) of <a class="el" href="a00045.html" title="Contains all components of the TINY language scanner.">TINY</a> language. <br /></td></tr>
127+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
128+
</table><table class="memberdecls">
129+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
130+
Variables</h2></td></tr>
131+
<tr class="memitem:ad227f8f659923f9b8bbbb824b65738af" id="r_ad227f8f659923f9b8bbbb824b65738af"><td class="memItemLeft" align="right" valign="top">static const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#ad227f8f659923f9b8bbbb824b65738af">TINY::SCANNER::DEFAULT_OUTPUT_FILE</a> = &quot;output/output.txt&quot;</td></tr>
132+
<tr class="separator:ad227f8f659923f9b8bbbb824b65738af"><td class="memSeparator" colspan="2">&#160;</td></tr>
133+
</table>
134+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
135+
<div class="textblock"><p>This file defines the App class, which manages the execution of the application. </p>
136+
<p>The App class is responsible for parsing command-line arguments, validating input, and running the application in either interactive mode or file mode. </p>
137+
138+
<p class="definition">Definition in file <a class="el" href="a00002_source.html">app.hpp</a>.</p>
139+
</div><h2 class="groupheader">Variable Documentation</h2>
140+
<a id="ad227f8f659923f9b8bbbb824b65738af" name="ad227f8f659923f9b8bbbb824b65738af"></a>
141+
<h2 class="memtitle"><span class="permalink"><a href="#ad227f8f659923f9b8bbbb824b65738af">&#9670;&#160;</a></span>DEFAULT_OUTPUT_FILE</h2>
142+
143+
<div class="memitem">
144+
<div class="memproto">
145+
<table class="mlabels">
146+
<tr>
147+
<td class="mlabels-left">
148+
<table class="memname">
149+
<tr>
150+
<td class="memname">const std::string TINY::SCANNER::DEFAULT_OUTPUT_FILE = &quot;output/output.txt&quot;</td>
151+
</tr>
152+
</table>
153+
</td>
154+
<td class="mlabels-right">
155+
<span class="mlabels"><span class="mlabel">static</span></span> </td>
156+
</tr>
157+
</table>
158+
</div><div class="memdoc">
159+
<p>Default output file path </p>
160+
161+
<p class="definition">Definition at line <a class="el" href="a00002_source.html#l00039">39</a> of file <a class="el" href="a00002_source.html">app.hpp</a>.</p>
162+
163+
</div>
164+
</div>
165+
</div><!-- contents -->
166+
</div><!-- doc-content -->
167+
<!-- start footer part -->
168+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
169+
<ul>
170+
<li class="navelem"><a class="el" href="dir_02b1a89c2d2186e4810ecb7fecaa3754.html">scanner</a></li><li class="navelem"><a class="el" href="dir_21050eab8d89c3a51dda2dd9ab15a33e.html">include</a></li><li class="navelem"><a class="el" href="a00002.html">app.hpp</a></li>
171+
<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.8 </li>
172+
</ul>
173+
</div>
174+
</body>
175+
</html>

‎scanner/docs/html/a00002.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
var a00002 =
2+
[
3+
[ "TINY::SCANNER::App", "a00863.html", "a00863" ],
4+
[ "DEFAULT_OUTPUT_FILE", "a00002.html#ad227f8f659923f9b8bbbb824b65738af", null ]
5+
];

0 commit comments

Comments
 (0)