Update Doxygen docs.

kartikkumar · Jan 3, 2025 · 1f69d3b · 1f69d3b
1 parent aabe0d7
commit 1f69d3b
Show file tree

Hide file tree

Showing 48 changed files with 613 additions and 523 deletions.
diff --git a/docs/html/README_8md.html b/docs/html/README_8md.html
@@ -3,7 +3,7 @@
 <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.12.0"/>
+<meta name="generator" content="Doxygen 1.13.1"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>sml: README.md File Reference</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -18,6 +18,11 @@
 <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>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+  $(function() { init_search(); });
+/* @license-end */
+</script>
 <link href="doxygen.css" rel="stylesheet" type="text/css" />
 </head>
 <body>
@@ -31,12 +36,24 @@
    </div>
    <div id="projectbrief">A simple mathematics library</div>
   </td>
+    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
+        <span class="left">
+          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
+          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
+               onfocus="searchBox.OnSearchFieldFocus(true)" 
+               onblur="searchBox.OnSearchFieldFocus(false)" 
+               onkeyup="searchBox.OnSearchFieldChange(event)"/>
+          </span><span class="right">
+            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
+          </span>
+        </div>
+</td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.12.0 -->
+<!-- Generated by Doxygen 1.13.1 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -47,17 +64,6 @@
 $(function() { codefold.init(0); });
 /* @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',true);
-  $(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">
@@ -106,7 +112,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="README_8md.html">README.md</a></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.12.0 </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.13.1 </li>
   </ul>
 </div>
 </body>

diff --git a/docs/html/basicFunctions_8hpp.html b/docs/html/basicFunctions_8hpp.html
@@ -3,7 +3,7 @@
 <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.12.0"/>
+<meta name="generator" content="Doxygen 1.13.1"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>sml: basicFunctions.hpp File Reference</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -18,6 +18,11 @@
 <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>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+  $(function() { init_search(); });
+/* @license-end */
+</script>
 <link href="doxygen.css" rel="stylesheet" type="text/css" />
 </head>
 <body>
@@ -31,12 +36,24 @@
    </div>
    <div id="projectbrief">A simple mathematics library</div>
   </td>
+    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
+        <span class="left">
+          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
+          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
+               onfocus="searchBox.OnSearchFieldFocus(true)" 
+               onblur="searchBox.OnSearchFieldFocus(false)" 
+               onkeyup="searchBox.OnSearchFieldChange(event)"/>
+          </span><span class="right">
+            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
+          </span>
+        </div>
+</td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.12.0 -->
+<!-- Generated by Doxygen 1.13.1 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -47,17 +64,6 @@
 $(function() { codefold.init(0); });
 /* @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',true);
-  $(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">
@@ -137,15 +143,15 @@
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
 Functions</h2></td></tr>
-<tr class="memitem:ab26ceb16aed143c1a37f4acfbcd63de8" id="r_ab26ceb16aed143c1a37f4acfbcd63de8"><td class="memTemplParams" colspan="2">template&lt;typename Real &gt; </td></tr>
+<tr class="memitem:ab26ceb16aed143c1a37f4acfbcd63de8" id="r_ab26ceb16aed143c1a37f4acfbcd63de8"><td class="memTemplParams" colspan="2">template&lt;typename Real&gt; </td></tr>
 <tr class="memitem:ab26ceb16aed143c1a37f4acfbcd63de8"><td class="memTemplItemLeft" align="right" valign="top">Real&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacesml.html#ab26ceb16aed143c1a37f4acfbcd63de8">sml::computeModulo</a> (const Real dividend, const Real divisor)</td></tr>
 <tr class="memdesc:ab26ceb16aed143c1a37f4acfbcd63de8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute modulo.  <br /></td></tr>
 <tr class="separator:ab26ceb16aed143c1a37f4acfbcd63de8"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a93758fc3d553c1d8e18f45ebf61a8afb" id="r_a93758fc3d553c1d8e18f45ebf61a8afb"><td class="memTemplParams" colspan="2">template&lt;typename Real &gt; </td></tr>
+<tr class="memitem:a93758fc3d553c1d8e18f45ebf61a8afb" id="r_a93758fc3d553c1d8e18f45ebf61a8afb"><td class="memTemplParams" colspan="2">template&lt;typename Real&gt; </td></tr>
 <tr class="memitem:a93758fc3d553c1d8e18f45ebf61a8afb"><td class="memTemplItemLeft" align="right" valign="top">Real&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacesml.html#a93758fc3d553c1d8e18f45ebf61a8afb">sml::convertRadiansToDegrees</a> (const Real angleInRadians)</td></tr>
 <tr class="memdesc:a93758fc3d553c1d8e18f45ebf61a8afb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert angle in radians to degrees.  <br /></td></tr>
 <tr class="separator:a93758fc3d553c1d8e18f45ebf61a8afb"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:abf1a4db730c356d33f098cfc8942dc10" id="r_abf1a4db730c356d33f098cfc8942dc10"><td class="memTemplParams" colspan="2">template&lt;typename Real &gt; </td></tr>
+<tr class="memitem:abf1a4db730c356d33f098cfc8942dc10" id="r_abf1a4db730c356d33f098cfc8942dc10"><td class="memTemplParams" colspan="2">template&lt;typename Real&gt; </td></tr>
 <tr class="memitem:abf1a4db730c356d33f098cfc8942dc10"><td class="memTemplItemLeft" align="right" valign="top">Real&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacesml.html#abf1a4db730c356d33f098cfc8942dc10">sml::convertDegreesToRadians</a> (const Real angleInDegrees)</td></tr>
 <tr class="memdesc:abf1a4db730c356d33f098cfc8942dc10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert angle in degrees to radians.  <br /></td></tr>
 <tr class="separator:abf1a4db730c356d33f098cfc8942dc10"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -156,7 +162,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b3d7d0de844b3caea53996c526e8984a.html">sml</a></li><li class="navelem"><a class="el" href="basicFunctions_8hpp.html">basicFunctions.hpp</a></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.12.0 </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.13.1 </li>
   </ul>
 </div>
 </body>

diff --git a/docs/html/basicFunctions_8hpp.js b/docs/html/basicFunctions_8hpp.js
@@ -1,6 +1,6 @@
 var basicFunctions_8hpp =
 [
-    [ "computeModulo", "basicFunctions_8hpp.html#ab26ceb16aed143c1a37f4acfbcd63de8", null ],
-    [ "convertRadiansToDegrees", "basicFunctions_8hpp.html#a93758fc3d553c1d8e18f45ebf61a8afb", null ],
-    [ "convertDegreesToRadians", "basicFunctions_8hpp.html#abf1a4db730c356d33f098cfc8942dc10", null ]
+    [ "sml::computeModulo", "namespacesml.html#ab26ceb16aed143c1a37f4acfbcd63de8", null ],
+    [ "sml::convertRadiansToDegrees", "namespacesml.html#a93758fc3d553c1d8e18f45ebf61a8afb", null ],
+    [ "sml::convertDegreesToRadians", "namespacesml.html#abf1a4db730c356d33f098cfc8942dc10", null ]
 ];
diff --git a/docs/html/basicFunctions_8hpp_source.html b/docs/html/basicFunctions_8hpp_source.html
@@ -3,7 +3,7 @@
 <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.12.0"/>
+<meta name="generator" content="Doxygen 1.13.1"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>sml: basicFunctions.hpp Source File</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -18,6 +18,11 @@
 <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>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+  $(function() { init_search(); });
+/* @license-end */
+</script>
 <link href="doxygen.css" rel="stylesheet" type="text/css" />
 </head>
 <body>
@@ -31,12 +36,24 @@
    </div>
    <div id="projectbrief">A simple mathematics library</div>
   </td>
+    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
+        <span class="left">
+          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
+          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
+               onfocus="searchBox.OnSearchFieldFocus(true)" 
+               onblur="searchBox.OnSearchFieldFocus(false)" 
+               onkeyup="searchBox.OnSearchFieldChange(event)"/>
+          </span><span class="right">
+            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
+          </span>
+        </div>
+</td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.12.0 -->
+<!-- Generated by Doxygen 1.13.1 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -47,17 +64,6 @@
 $(function() { codefold.init(0); });
 /* @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',true);
-  $(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">
@@ -115,26 +121,26 @@
 <div class="foldopen" id="foldopen00013" data-start="{" data-end="}">
 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="namespacesml.html">   13</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacesml.html">sml</a></div>
 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span>{</div>
-<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span> </div>
-<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span> </div>
+<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span></div>
+<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span></div>
 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Real&gt;</div>
 <div class="foldopen" id="foldopen00032" data-start="{" data-end="}">
 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="namespacesml.html#ab26ceb16aed143c1a37f4acfbcd63de8">   32</a></span>Real <a class="code hl_function" href="namespacesml.html#ab26ceb16aed143c1a37f4acfbcd63de8">computeModulo</a>(<span class="keyword">const</span> Real dividend, <span class="keyword">const</span> Real divisor)</div>
 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>{</div>
 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>    <span class="keywordflow">return</span> dividend - divisor * std::floor(dividend / divisor);</div>
 <div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>}</div>
 </div>
-<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span> </div>
-<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span> </div>
+<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span></div>
+<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span></div>
 <div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Real&gt;</div>
 <div class="foldopen" id="foldopen00050" data-start="{" data-end="}">
 <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="namespacesml.html#a93758fc3d553c1d8e18f45ebf61a8afb">   50</a></span>Real <a class="code hl_function" href="namespacesml.html#a93758fc3d553c1d8e18f45ebf61a8afb">convertRadiansToDegrees</a>(<span class="keyword">const</span> Real angleInRadians)</div>
 <div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>{</div>
 <div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>    <span class="keywordflow">return</span> angleInRadians / <a class="code hl_variable" href="namespacesml.html#a0de6c4d6b9d119a350d844894ddfa7de">SML_PI</a> * 180.0;</div>
 <div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>}</div>
 </div>
-<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span> </div>
-<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span> </div>
+<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span></div>
+<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span></div>
 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> Real&gt;</div>
 <div class="foldopen" id="foldopen00068" data-start="{" data-end="}">
 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="namespacesml.html#abf1a4db730c356d33f098cfc8942dc10">   68</a></span>Real <a class="code hl_function" href="namespacesml.html#abf1a4db730c356d33f098cfc8942dc10">convertDegreesToRadians</a>(<span class="keyword">const</span> Real angleInDegrees)</div>
@@ -157,7 +163,7 @@
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b3d7d0de844b3caea53996c526e8984a.html">sml</a></li><li class="navelem"><a class="el" href="basicFunctions_8hpp.html">basicFunctions.hpp</a></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.12.0 </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.13.1 </li>
   </ul>
 </div>
 </body>