Update Doxygen docs.

kartikkumar · Jul 9, 2024 · e834535 · e834535
1 parent b30f4db
commit e834535
Show file tree

Hide file tree

Showing 29 changed files with 605 additions and 408 deletions.
diff --git a/docs/html/README_8md.html b/docs/html/README_8md.html
@@ -3,17 +3,17 @@
 <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.10.0"/>
+<meta name="generator" content="Doxygen 1.11.0"/>
 <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"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
 <script type="text/javascript" src="clipboard.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>
+<script type="text/javascript" src="resize.js"></script>
 <script type="text/javascript" src="cookie.js"></script>
 <link href="search/search.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="search/searchdata.js"></script>
@@ -36,18 +36,23 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.10.0 -->
+<!-- Generated by Doxygen 1.11.0 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
 /* @license-end */
 </script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+$(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');
+  initMenu('',true,false,'search.php','Search',true);
   $(function() { init_search(); });
 });
 /* @license-end */
@@ -66,7 +71,7 @@
 </div>
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
-$(function(){initNavTree('README_8md.html',''); initResizable(); });
+$(function(){initNavTree('README_8md.html',''); initResizable(true); });
 /* @license-end */
 </script>
 <div id="doc-content">
@@ -101,7 +106,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.10.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.11.0 </li>
   </ul>
 </div>
 </body>

diff --git a/docs/html/basicFunctions_8hpp.html b/docs/html/basicFunctions_8hpp.html
@@ -3,17 +3,17 @@
 <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.10.0"/>
+<meta name="generator" content="Doxygen 1.11.0"/>
 <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"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
 <script type="text/javascript" src="clipboard.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>
+<script type="text/javascript" src="resize.js"></script>
 <script type="text/javascript" src="cookie.js"></script>
 <link href="search/search.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="search/searchdata.js"></script>
@@ -36,18 +36,23 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.10.0 -->
+<!-- Generated by Doxygen 1.11.0 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
 /* @license-end */
 </script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+$(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');
+  initMenu('',true,false,'search.php','Search',true);
   $(function() { init_search(); });
 });
 /* @license-end */
@@ -66,7 +71,7 @@
 </div>
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
-$(function(){initNavTree('basicFunctions_8hpp.html',''); initResizable(); });
+$(function(){initNavTree('basicFunctions_8hpp.html',''); initResizable(true); });
 /* @license-end */
 </script>
 <div id="doc-content">
@@ -127,21 +132,21 @@
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
 Namespaces</h2></td></tr>
-<tr class="memitem:namespacesml" id="r_namespacesml"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesml.html">sml</a></td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesml.html">sml</a></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </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;<a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">typename</a> <a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">Real</a> &gt; </td></tr>
-<tr class="memitem:ab26ceb16aed143c1a37f4acfbcd63de8"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">Real</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacesml.html#ab26ceb16aed143c1a37f4acfbcd63de8">sml::computeModulo</a> (<a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">const</a> <a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">Real</a> <a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">dividend</a>, <a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">const</a> <a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">Real</a> <a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">divisor</a>)</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;<a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">typename</a> <a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">Real</a> &gt; </td></tr>
-<tr class="memitem:a93758fc3d553c1d8e18f45ebf61a8afb"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">Real</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacesml.html#a93758fc3d553c1d8e18f45ebf61a8afb">sml::convertRadiansToDegrees</a> (<a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">const</a> <a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">Real</a> <a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">angleInRadians</a>)</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;<a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">typename</a> <a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">Real</a> &gt; </td></tr>
-<tr class="memitem:abf1a4db730c356d33f098cfc8942dc10"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">Real</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacesml.html#abf1a4db730c356d33f098cfc8942dc10">sml::convertDegreesToRadians</a> (<a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">const</a> <a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">Real</a> <a class="el" href="namespacesml.html#ada9f4bff1a65b87090ca1a604b8ea663">angleInDegrees</a>)</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>
 </table>
@@ -151,7 +156,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.10.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.11.0 </li>
   </ul>
 </div>
 </body>

diff --git a/docs/html/basicFunctions_8hpp_source.html b/docs/html/basicFunctions_8hpp_source.html
@@ -3,17 +3,17 @@
 <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.10.0"/>
+<meta name="generator" content="Doxygen 1.11.0"/>
 <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"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
 <script type="text/javascript" src="clipboard.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>
+<script type="text/javascript" src="resize.js"></script>
 <script type="text/javascript" src="cookie.js"></script>
 <link href="search/search.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="search/searchdata.js"></script>
@@ -36,28 +36,28 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.10.0 -->
+<!-- Generated by Doxygen 1.11.0 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
 /* @license-end */
 </script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+$(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');
+  initMenu('',true,false,'search.php','Search',true);
   $(function() { init_search(); });
 });
 /* @license-end */
 </script>
 <div id="main-nav"></div>
-<script type="text/javascript">
-/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
-$(function() { codefold.init(0); });
-/* @license-end */
-</script>
 </div><!-- top -->
 <div id="side-nav" class="ui-resizable side-nav-resizable">
   <div id="nav-tree">
@@ -71,7 +71,7 @@
 </div>
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
-$(function(){initNavTree('basicFunctions_8hpp_source.html',''); initResizable(); });
+$(function(){initNavTree('basicFunctions_8hpp_source.html',''); initResizable(true); });
 /* @license-end */
 </script>
 <div id="doc-content">
@@ -157,7 +157,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.10.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.11.0 </li>
   </ul>
 </div>
 </body>