Skip to content

Commit

Permalink
Update Doxygen docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Kartik Kumar committed Jan 20, 2024
1 parent 9b38110 commit b30f4db
Show file tree
Hide file tree
Showing 34 changed files with 1,639 additions and 1,566 deletions.
12 changes: 7 additions & 5 deletions docs/html/README_8md.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,18 @@
<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.9.8"/>
<meta name="generator" content="Doxygen 1.10.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="cookie.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>
Expand All @@ -34,7 +36,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
Expand All @@ -46,7 +48,7 @@
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
$(function() { init_search(); });
});
/* @license-end */
</script>
Expand All @@ -64,7 +66,7 @@
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('README_8md.html',''); initResizable(); });
$(function(){initNavTree('README_8md.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
Expand Down Expand Up @@ -99,7 +101,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.9.8 </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>
</ul>
</div>
</body>
Expand Down
12 changes: 7 additions & 5 deletions docs/html/basicFunctions_8hpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,18 @@
<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.9.8"/>
<meta name="generator" content="Doxygen 1.10.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="cookie.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>
Expand All @@ -34,7 +36,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
Expand All @@ -46,7 +48,7 @@
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
$(function() { init_search(); });
});
/* @license-end */
</script>
Expand All @@ -64,7 +66,7 @@
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('basicFunctions_8hpp.html',''); initResizable(); });
$(function(){initNavTree('basicFunctions_8hpp.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
Expand Down Expand Up @@ -149,7 +151,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.9.8 </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>
</ul>
</div>
</body>
Expand Down
22 changes: 12 additions & 10 deletions docs/html/basicFunctions_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,18 @@
<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.9.8"/>
<meta name="generator" content="Doxygen 1.10.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="cookie.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>
Expand All @@ -34,7 +36,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
Expand All @@ -46,14 +48,14 @@
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
$(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 */
$(document).ready(function() { init_codefold(0); });
$(function() { codefold.init(0); });
/* @license-end */
</script>
</div><!-- top -->
Expand All @@ -69,7 +71,7 @@
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('basicFunctions_8hpp_source.html',''); initResizable(); });
$(function(){initNavTree('basicFunctions_8hpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
Expand Down Expand Up @@ -144,18 +146,18 @@
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span>} <span class="comment">// namespace sml</span></div>
</div>
<div class="ttc" id="aconstants_8hpp_html"><div class="ttname"><a href="constants_8hpp.html">constants.hpp</a></div></div>
<div class="ttc" id="anamespacesml_html"><div class="ttname"><a href="namespacesml.html">sml</a></div><div class="ttdef"><b>Definition</b> <a href="basicFunctions_8hpp_source.html#l00013">basicFunctions.hpp:14</a></div></div>
<div class="ttc" id="anamespacesml_html"><div class="ttname"><a href="namespacesml.html">sml</a></div><div class="ttdef"><b>Definition</b> <a href="#l00013">basicFunctions.hpp:14</a></div></div>
<div class="ttc" id="anamespacesml_html_a0de6c4d6b9d119a350d844894ddfa7de"><div class="ttname"><a href="namespacesml.html#a0de6c4d6b9d119a350d844894ddfa7de">sml::SML_PI</a></div><div class="ttdeci">static const double SML_PI</div><div class="ttdoc">to 20 decimal places.</div><div class="ttdef"><b>Definition</b> <a href="constants_8hpp_source.html#l00013">constants.hpp:13</a></div></div>
<div class="ttc" id="anamespacesml_html_a93758fc3d553c1d8e18f45ebf61a8afb"><div class="ttname"><a href="namespacesml.html#a93758fc3d553c1d8e18f45ebf61a8afb">sml::convertRadiansToDegrees</a></div><div class="ttdeci">Real convertRadiansToDegrees(const Real angleInRadians)</div><div class="ttdoc">Convert angle in radians to degrees.</div><div class="ttdef"><b>Definition</b> <a href="basicFunctions_8hpp_source.html#l00050">basicFunctions.hpp:50</a></div></div>
<div class="ttc" id="anamespacesml_html_ab26ceb16aed143c1a37f4acfbcd63de8"><div class="ttname"><a href="namespacesml.html#ab26ceb16aed143c1a37f4acfbcd63de8">sml::computeModulo</a></div><div class="ttdeci">Real computeModulo(const Real dividend, const Real divisor)</div><div class="ttdoc">Compute modulo.</div><div class="ttdef"><b>Definition</b> <a href="basicFunctions_8hpp_source.html#l00032">basicFunctions.hpp:32</a></div></div>
<div class="ttc" id="anamespacesml_html_abf1a4db730c356d33f098cfc8942dc10"><div class="ttname"><a href="namespacesml.html#abf1a4db730c356d33f098cfc8942dc10">sml::convertDegreesToRadians</a></div><div class="ttdeci">Real convertDegreesToRadians(const Real angleInDegrees)</div><div class="ttdoc">Convert angle in degrees to radians.</div><div class="ttdef"><b>Definition</b> <a href="basicFunctions_8hpp_source.html#l00068">basicFunctions.hpp:68</a></div></div>
<div class="ttc" id="anamespacesml_html_a93758fc3d553c1d8e18f45ebf61a8afb"><div class="ttname"><a href="namespacesml.html#a93758fc3d553c1d8e18f45ebf61a8afb">sml::convertRadiansToDegrees</a></div><div class="ttdeci">Real convertRadiansToDegrees(const Real angleInRadians)</div><div class="ttdoc">Convert angle in radians to degrees.</div><div class="ttdef"><b>Definition</b> <a href="#l00050">basicFunctions.hpp:50</a></div></div>
<div class="ttc" id="anamespacesml_html_ab26ceb16aed143c1a37f4acfbcd63de8"><div class="ttname"><a href="namespacesml.html#ab26ceb16aed143c1a37f4acfbcd63de8">sml::computeModulo</a></div><div class="ttdeci">Real computeModulo(const Real dividend, const Real divisor)</div><div class="ttdoc">Compute modulo.</div><div class="ttdef"><b>Definition</b> <a href="#l00032">basicFunctions.hpp:32</a></div></div>
<div class="ttc" id="anamespacesml_html_abf1a4db730c356d33f098cfc8942dc10"><div class="ttname"><a href="namespacesml.html#abf1a4db730c356d33f098cfc8942dc10">sml::convertDegreesToRadians</a></div><div class="ttdeci">Real convertDegreesToRadians(const Real angleInDegrees)</div><div class="ttdoc">Convert angle in degrees to radians.</div><div class="ttdef"><b>Definition</b> <a href="#l00068">basicFunctions.hpp:68</a></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_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.9.8 </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>
</ul>
</div>
</body>
Expand Down
61 changes: 61 additions & 0 deletions docs/html/clipboard.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/**
The code below is based on the Doxygen Awesome project, see
https://github.com/jothepro/doxygen-awesome-css
MIT License
Copyright (c) 2021 - 2022 jothepro
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

let clipboard_title = "Copy to clipboard"
let clipboard_icon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z"/></svg>`
let clipboard_successIcon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41L9 16.17z"/></svg>`
let clipboard_successDuration = 1000

$(function() {
if(navigator.clipboard) {
const fragments = document.getElementsByClassName("fragment")
for(const fragment of fragments) {
const clipboard_div = document.createElement("div")
clipboard_div.classList.add("clipboard")
clipboard_div.innerHTML = clipboard_icon
clipboard_div.title = clipboard_title
$(clipboard_div).click(function() {
const content = this.parentNode.cloneNode(true)
// filter out line number and folded fragments from file listings
content.querySelectorAll(".lineno, .ttc, .foldclosed").forEach((node) => { node.remove() })
let text = content.textContent
// remove trailing newlines and trailing spaces from empty lines
text = text.replace(/^\s*\n/gm,'\n').replace(/\n*$/,'')
navigator.clipboard.writeText(text);
this.classList.add("success")
this.innerHTML = clipboard_successIcon
window.setTimeout(() => { // switch back to normal icon after timeout
this.classList.remove("success")
this.innerHTML = clipboard_icon
}, clipboard_successDuration);
})
fragment.insertBefore(clipboard_div, fragment.firstChild)
}
}
})
12 changes: 7 additions & 5 deletions docs/html/constants_8hpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,18 @@
<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.9.8"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>sml: constants.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="cookie.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>
Expand All @@ -34,7 +36,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
Expand All @@ -46,7 +48,7 @@
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
$(function() { init_search(); });
});
/* @license-end */
</script>
Expand All @@ -64,7 +66,7 @@
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('constants_8hpp.html',''); initResizable(); });
$(function(){initNavTree('constants_8hpp.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
Expand Down Expand Up @@ -129,7 +131,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="constants_8hpp.html">constants.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.9.8 </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>
</ul>
</div>
</body>
Expand Down
Loading

0 comments on commit b30f4db

Please sign in to comment.