Skip to content

Commit f4549da

Browse files
FloatingFowlFloatingFowl
committed
Added documentation for all files
1 parent f580686 commit f4549da

170 files changed

Lines changed: 15283 additions & 646 deletions

File tree

Some content is hidden

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

‎docs/Doxyfile‎

Lines changed: 2482 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/html/_big_int_8hpp.html‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.14"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>/Users/Mohsin/Repos/BigInt/include/BigInt.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="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<script type="text/x-mathjax-config">
16+
MathJax.Hub.Config({
17+
extensions: ["tex2jax.js"],
18+
jax: ["input/TeX","output/HTML-CSS"],
19+
});
20+
</script><script type="text/javascript" async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js"></script>
21+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
22+
</head>
23+
<body>
24+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
25+
<div id="titlearea">
26+
<table cellspacing="0" cellpadding="0">
27+
<tbody>
28+
<tr style="height: 56px;">
29+
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
30+
<td style="padding-left: 0.5em;">
31+
<div id="projectbrief">Big Integer library for C++</div>
32+
</td>
33+
</tr>
34+
</tbody>
35+
</table>
36+
</div>
37+
<!-- end header part -->
38+
<!-- Generated by Doxygen 1.8.14 -->
39+
<script type="text/javascript">
40+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
41+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
42+
/* @license-end */
43+
</script>
44+
<script type="text/javascript" src="menudata.js"></script>
45+
<script type="text/javascript" src="menu.js"></script>
46+
<script type="text/javascript">
47+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
48+
$(function() {
49+
initMenu('',true,false,'search.php','Search');
50+
$(document).ready(function() { init_search(); });
51+
});
52+
/* @license-end */</script>
53+
<div id="main-nav"></div>
54+
<!-- window showing the filter options -->
55+
<div id="MSearchSelectWindow"
56+
onmouseover="return searchBox.OnSearchSelectShow()"
57+
onmouseout="return searchBox.OnSearchSelectHide()"
58+
onkeydown="return searchBox.OnSearchSelectKey(event)">
59+
</div>
60+
61+
<!-- iframe showing the search results (closed by default) -->
62+
<div id="MSearchResultsWindow">
63+
<iframe src="javascript:void(0)" frameborder="0"
64+
name="MSearchResults" id="MSearchResults">
65+
</iframe>
66+
</div>
67+
68+
<div id="nav-path" class="navpath">
69+
<ul>
70+
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
71+
</div>
72+
</div><!-- top -->
73+
<div class="header">
74+
<div class="summary">
75+
<a href="#nested-classes">Classes</a> </div>
76+
<div class="headertitle">
77+
<div class="title">BigInt.hpp File Reference</div> </div>
78+
</div><!--header-->
79+
<div class="contents">
80+
81+
<p>Contains class declaration for <a class="el" href="class_big_int.html" title="Class that contains an arbitrarily sized integer. ">BigInt</a>.
82+
<a href="#details">More...</a></p>
83+
<div class="textblock"><code>#include &lt;iostream&gt;</code><br />
84+
</div>
85+
<p><a href="_big_int_8hpp_source.html">Go to the source code of this file.</a></p>
86+
<table class="memberdecls">
87+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
88+
Classes</h2></td></tr>
89+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_big_int.html">BigInt</a></td></tr>
90+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class that contains an arbitrarily sized integer. <a href="class_big_int.html#details">More...</a><br /></td></tr>
91+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
92+
</table>
93+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
94+
<div class="textblock"><p>Contains class declaration for <a class="el" href="class_big_int.html" title="Class that contains an arbitrarily sized integer. ">BigInt</a>. </p>
95+
</div></div><!-- contents -->
96+
<!-- start footer part -->
97+
<hr class="footer"/><address class="footer"><small>
98+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
99+
<img class="footer" src="doxygen.png" alt="doxygen"/>
100+
</a> 1.8.14
101+
</small></address>
102+
</body>
103+
</html>

‎docs/html/_big_int_8hpp_source.html‎

Lines changed: 114 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/html/annotated.html‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.14"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Class List</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="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<script type="text/x-mathjax-config">
16+
MathJax.Hub.Config({
17+
extensions: ["tex2jax.js"],
18+
jax: ["input/TeX","output/HTML-CSS"],
19+
});
20+
</script><script type="text/javascript" async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js"></script>
21+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
22+
</head>
23+
<body>
24+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
25+
<div id="titlearea">
26+
<table cellspacing="0" cellpadding="0">
27+
<tbody>
28+
<tr style="height: 56px;">
29+
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
30+
<td style="padding-left: 0.5em;">
31+
<div id="projectbrief">Big Integer library for C++</div>
32+
</td>
33+
</tr>
34+
</tbody>
35+
</table>
36+
</div>
37+
<!-- end header part -->
38+
<!-- Generated by Doxygen 1.8.14 -->
39+
<script type="text/javascript">
40+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
41+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
42+
/* @license-end */
43+
</script>
44+
<script type="text/javascript" src="menudata.js"></script>
45+
<script type="text/javascript" src="menu.js"></script>
46+
<script type="text/javascript">
47+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
48+
$(function() {
49+
initMenu('',true,false,'search.php','Search');
50+
$(document).ready(function() { init_search(); });
51+
});
52+
/* @license-end */</script>
53+
<div id="main-nav"></div>
54+
</div><!-- top -->
55+
<!-- window showing the filter options -->
56+
<div id="MSearchSelectWindow"
57+
onmouseover="return searchBox.OnSearchSelectShow()"
58+
onmouseout="return searchBox.OnSearchSelectHide()"
59+
onkeydown="return searchBox.OnSearchSelectKey(event)">
60+
</div>
61+
62+
<!-- iframe showing the search results (closed by default) -->
63+
<div id="MSearchResultsWindow">
64+
<iframe src="javascript:void(0)" frameborder="0"
65+
name="MSearchResults" id="MSearchResults">
66+
</iframe>
67+
</div>
68+
69+
<div class="header">
70+
<div class="headertitle">
71+
<div class="title">Class List</div> </div>
72+
</div><!--header-->
73+
<div class="contents">
74+
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
75+
<table class="directory">
76+
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_big_int.html" target="_self">BigInt</a></td><td class="desc">Class that contains an arbitrarily sized integer </td></tr>
77+
</table>
78+
</div><!-- directory -->
79+
</div><!-- contents -->
80+
<!-- start footer part -->
81+
<hr class="footer"/><address class="footer"><small>
82+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
83+
<img class="footer" src="doxygen.png" alt="doxygen"/>
84+
</a> 1.8.14
85+
</small></address>
86+
</body>
87+
</html>

‎docs/html/arithmetic__assignment_8hpp.html‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.14"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>/Users/Mohsin/Repos/BigInt/include/operators/arithmetic_assignment.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="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<script type="text/x-mathjax-config">
16+
MathJax.Hub.Config({
17+
extensions: ["tex2jax.js"],
18+
jax: ["input/TeX","output/HTML-CSS"],
19+
});
20+
</script><script type="text/javascript" async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js"></script>
21+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
22+
</head>
23+
<body>
24+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
25+
<div id="titlearea">
26+
<table cellspacing="0" cellpadding="0">
27+
<tbody>
28+
<tr style="height: 56px;">
29+
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
30+
<td style="padding-left: 0.5em;">
31+
<div id="projectbrief">Big Integer library for C++</div>
32+
</td>
33+
</tr>
34+
</tbody>
35+
</table>
36+
</div>
37+
<!-- end header part -->
38+
<!-- Generated by Doxygen 1.8.14 -->
39+
<script type="text/javascript">
40+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
41+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
42+
/* @license-end */
43+
</script>
44+
<script type="text/javascript" src="menudata.js"></script>
45+
<script type="text/javascript" src="menu.js"></script>
46+
<script type="text/javascript">
47+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
48+
$(function() {
49+
initMenu('',true,false,'search.php','Search');
50+
$(document).ready(function() { init_search(); });
51+
});
52+
/* @license-end */</script>
53+
<div id="main-nav"></div>
54+
<!-- window showing the filter options -->
55+
<div id="MSearchSelectWindow"
56+
onmouseover="return searchBox.OnSearchSelectShow()"
57+
onmouseout="return searchBox.OnSearchSelectHide()"
58+
onkeydown="return searchBox.OnSearchSelectKey(event)">
59+
</div>
60+
61+
<!-- iframe showing the search results (closed by default) -->
62+
<div id="MSearchResultsWindow">
63+
<iframe src="javascript:void(0)" frameborder="0"
64+
name="MSearchResults" id="MSearchResults">
65+
</iframe>
66+
</div>
67+
68+
<div id="nav-path" class="navpath">
69+
<ul>
70+
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_25195d3308bac8cd1082ed7a447aeb6c.html">operators</a></li> </ul>
71+
</div>
72+
</div><!-- top -->
73+
<div class="header">
74+
<div class="headertitle">
75+
<div class="title">arithmetic_assignment.hpp File Reference</div> </div>
76+
</div><!--header-->
77+
<div class="contents">
78+
79+
<p>Arithmetic-assignment operators.
80+
<a href="#details">More...</a></p>
81+
<div class="textblock"><code>#include &quot;<a class="el" href="_big_int_8hpp_source.html">BigInt.hpp</a>&quot;</code><br />
82+
<code>#include &quot;<a class="el" href="constructors_8hpp_source.html">constructors/constructors.hpp</a>&quot;</code><br />
83+
<code>#include &quot;<a class="el" href="assignment_8hpp_source.html">operators/assignment.hpp</a>&quot;</code><br />
84+
<code>#include &quot;<a class="el" href="binary__arithmetic_8hpp_source.html">operators/binary_arithmetic.hpp</a>&quot;</code><br />
85+
</div>
86+
<p><a href="arithmetic__assignment_8hpp_source.html">Go to the source code of this file.</a></p>
87+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
88+
<div class="textblock"><p>Arithmetic-assignment operators. </p>
89+
</div></div><!-- contents -->
90+
<!-- start footer part -->
91+
<hr class="footer"/><address class="footer"><small>
92+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
93+
<img class="footer" src="doxygen.png" alt="doxygen"/>
94+
</a> 1.8.14
95+
</small></address>
96+
</body>
97+
</html>

‎docs/html/arithmetic__assignment_8hpp_source.html‎

Lines changed: 97 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/html/assignment_8hpp.html‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.14"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>/Users/Mohsin/Repos/BigInt/include/operators/assignment.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="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<script type="text/x-mathjax-config">
16+
MathJax.Hub.Config({
17+
extensions: ["tex2jax.js"],
18+
jax: ["input/TeX","output/HTML-CSS"],
19+
});
20+
</script><script type="text/javascript" async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js"></script>
21+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
22+
</head>
23+
<body>
24+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
25+
<div id="titlearea">
26+
<table cellspacing="0" cellpadding="0">
27+
<tbody>
28+
<tr style="height: 56px;">
29+
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
30+
<td style="padding-left: 0.5em;">
31+
<div id="projectbrief">Big Integer library for C++</div>
32+
</td>
33+
</tr>
34+
</tbody>
35+
</table>
36+
</div>
37+
<!-- end header part -->
38+
<!-- Generated by Doxygen 1.8.14 -->
39+
<script type="text/javascript">
40+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
41+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
42+
/* @license-end */
43+
</script>
44+
<script type="text/javascript" src="menudata.js"></script>
45+
<script type="text/javascript" src="menu.js"></script>
46+
<script type="text/javascript">
47+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
48+
$(function() {
49+
initMenu('',true,false,'search.php','Search');
50+
$(document).ready(function() { init_search(); });
51+
});
52+
/* @license-end */</script>
53+
<div id="main-nav"></div>
54+
<!-- window showing the filter options -->
55+
<div id="MSearchSelectWindow"
56+
onmouseover="return searchBox.OnSearchSelectShow()"
57+
onmouseout="return searchBox.OnSearchSelectHide()"
58+
onkeydown="return searchBox.OnSearchSelectKey(event)">
59+
</div>
60+
61+
<!-- iframe showing the search results (closed by default) -->
62+
<div id="MSearchResultsWindow">
63+
<iframe src="javascript:void(0)" frameborder="0"
64+
name="MSearchResults" id="MSearchResults">
65+
</iframe>
66+
</div>
67+
68+
<div id="nav-path" class="navpath">
69+
<ul>
70+
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_25195d3308bac8cd1082ed7a447aeb6c.html">operators</a></li> </ul>
71+
</div>
72+
</div><!-- top -->
73+
<div class="header">
74+
<div class="headertitle">
75+
<div class="title">assignment.hpp File Reference</div> </div>
76+
</div><!--header-->
77+
<div class="contents">
78+
79+
<p>Assignment operators of <a class="el" href="class_big_int.html" title="Class that contains an arbitrarily sized integer. ">BigInt</a>.
80+
<a href="#details">More...</a></p>
81+
<div class="textblock"><code>#include &quot;<a class="el" href="_big_int_8hpp_source.html">BigInt.hpp</a>&quot;</code><br />
82+
<code>#include &quot;<a class="el" href="constructors_8hpp_source.html">constructors/constructors.hpp</a>&quot;</code><br />
83+
</div>
84+
<p><a href="assignment_8hpp_source.html">Go to the source code of this file.</a></p>
85+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
86+
<div class="textblock"><p>Assignment operators of <a class="el" href="class_big_int.html" title="Class that contains an arbitrarily sized integer. ">BigInt</a>. </p>
87+
</div></div><!-- contents -->
88+
<!-- start footer part -->
89+
<hr class="footer"/><address class="footer"><small>
90+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
91+
<img class="footer" src="doxygen.png" alt="doxygen"/>
92+
</a> 1.8.14
93+
</small></address>
94+
</body>
95+
</html>

0 commit comments

Comments
 (0)