Fix issues with documentation generation

Samleo8 · May 5, 2022 · cd626b0 · cd626b0
1 parent c9f0c38
commit cd626b0
Show file tree

Hide file tree

Showing 293 changed files with 25,505 additions and 12 deletions.
diff --git a/Doxyfile b/Doxyfile
@@ -743,7 +743,7 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ./doc/python/netconf.py
+INPUT                  = 
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -810,7 +810,7 @@ FILE_PATTERNS          = *.c \
 # be searched for input files as well.
 # The default value is: NO.
 
-RECURSIVE              = YES
+RECURSIVE              = NO
 
 # The EXCLUDE tag can be used to specify files and/or directories that should be
 # excluded from the INPUT source files. This way you can easily exclude a
@@ -819,7 +819,7 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                = 
+EXCLUDE                = g2o/*
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded

diff --git a/doc/html/annotated.html b/doc/html/annotated.html
@@ -0,0 +1,119 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<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.3"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>RAW-ROAM: Class List</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>
+<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>
+<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>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr id="projectrow">
+  <td id="projectalign">
+   <div id="projectname">RAW-ROAM
+   </div>
+   <div id="projectbrief">Python Re-implementation of RadarSLAM&#39;s odometry and mapping (ROAM) components</div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.9.3 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+var searchBox = new SearchBox("searchBox", "search",'Search','.html');
+/* @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');
+  $(document).ready(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">
+    <div id="nav-tree-contents">
+      <div id="nav-sync" class="sync"></div>
+    </div>
+  </div>
+  <div id="splitbar" style="-moz-user-select:none;" 
+       class="ui-resizable-handle">
+  </div>
+</div>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+$(document).ready(function(){initNavTree('annotated.html',''); initResizable(); });
+/* @license-end */
+</script>
+<div id="doc-content">
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="header">
+  <div class="headertitle"><div class="title">Class List</div></div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
+<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
+<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespace_coord.html" target="_self">Coord</a></td><td class="desc"></td></tr>
+<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_coord_1_1_cart_coord.html" target="_self">CartCoord</a></td><td class="desc"></td></tr>
+<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_coord_1_1_polar_coord.html" target="_self">PolarCoord</a></td><td class="desc"></td></tr>
+<tr id="row_1_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespace_mapping.html" target="_self">Mapping</a></td><td class="desc"></td></tr>
+<tr id="row_1_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_mapping_1_1_keyframe.html" target="_self">Keyframe</a></td><td class="desc"></td></tr>
+<tr id="row_1_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_mapping_1_1_map.html" target="_self">Map</a></td><td class="desc"></td></tr>
+<tr id="row_2_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_2_" class="arrow" onclick="toggleFolder('2_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacemotion_distortion.html" target="_self">motionDistortion</a></td><td class="desc"></td></tr>
+<tr id="row_2_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmotion_distortion_1_1_motion_distortion_solver.html" target="_self">MotionDistortionSolver</a></td><td class="desc"></td></tr>
+<tr id="row_3_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_3_" class="arrow" onclick="toggleFolder('3_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespace_pose_graph_lib.html" target="_self">PoseGraphLib</a></td><td class="desc"></td></tr>
+<tr id="row_3_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_pose_graph_lib_1_1_bundle_adjustment.html" target="_self">BundleAdjustment</a></td><td class="desc"></td></tr>
+<tr id="row_3_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_pose_graph_lib_1_1_pose_graph_optimization.html" target="_self">PoseGraphOptimization</a></td><td class="desc"></td></tr>
+<tr id="row_4_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_4_" class="arrow" onclick="toggleFolder('4_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespace_raw_r_o_a_m_system.html" target="_self">RawROAMSystem</a></td><td class="desc"></td></tr>
+<tr id="row_4_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_raw_r_o_a_m_system_1_1_raw_r_o_a_m_system.html" target="_self">RawROAMSystem</a></td><td class="desc"></td></tr>
+<tr id="row_5_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_5_" class="arrow" onclick="toggleFolder('5_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespace_tracker.html" target="_self">Tracker</a></td><td class="desc"></td></tr>
+<tr id="row_5_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_tracker_1_1_tracker.html" target="_self">Tracker</a></td><td class="desc"></td></tr>
+<tr id="row_6_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_6_" class="arrow" onclick="toggleFolder('6_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacetrajectory_plotting.html" target="_self">trajectoryPlotting</a></td><td class="desc"></td></tr>
+<tr id="row_6_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classtrajectory_plotting_1_1_trajectory.html" target="_self">Trajectory</a></td><td class="desc"></td></tr>
+</table>
+</div><!-- directory -->
+</div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="footer">Generated on Thu May 5 2022 00:51:39 for RAW-ROAM by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 </li>
+  </ul>
+</div>
+</body>
+</html>
diff --git a/doc/html/annotated_dup.js b/doc/html/annotated_dup.js
@@ -0,0 +1,27 @@
+var annotated_dup =
+[
+    [ "Coord", "namespace_coord.html", [
+      [ "CartCoord", "class_coord_1_1_cart_coord.html", "class_coord_1_1_cart_coord" ],
+      [ "PolarCoord", "class_coord_1_1_polar_coord.html", "class_coord_1_1_polar_coord" ]
+    ] ],
+    [ "Mapping", "namespace_mapping.html", [
+      [ "Keyframe", "class_mapping_1_1_keyframe.html", "class_mapping_1_1_keyframe" ],
+      [ "Map", "class_mapping_1_1_map.html", "class_mapping_1_1_map" ]
+    ] ],
+    [ "motionDistortion", "namespacemotion_distortion.html", [
+      [ "MotionDistortionSolver", "classmotion_distortion_1_1_motion_distortion_solver.html", "classmotion_distortion_1_1_motion_distortion_solver" ]
+    ] ],
+    [ "PoseGraphLib", "namespace_pose_graph_lib.html", [
+      [ "BundleAdjustment", "class_pose_graph_lib_1_1_bundle_adjustment.html", "class_pose_graph_lib_1_1_bundle_adjustment" ],
+      [ "PoseGraphOptimization", "class_pose_graph_lib_1_1_pose_graph_optimization.html", "class_pose_graph_lib_1_1_pose_graph_optimization" ]
+    ] ],
+    [ "RawROAMSystem", "namespace_raw_r_o_a_m_system.html", [
+      [ "RawROAMSystem", "class_raw_r_o_a_m_system_1_1_raw_r_o_a_m_system.html", "class_raw_r_o_a_m_system_1_1_raw_r_o_a_m_system" ]
+    ] ],
+    [ "Tracker", "namespace_tracker.html", [
+      [ "Tracker", "class_tracker_1_1_tracker.html", "class_tracker_1_1_tracker" ]
+    ] ],
+    [ "trajectoryPlotting", "namespacetrajectory_plotting.html", [
+      [ "Trajectory", "classtrajectory_plotting_1_1_trajectory.html", "classtrajectory_plotting_1_1_trajectory" ]
+    ] ]
+];
diff --git a/doc/html/class_coord_1_1_cart_coord-members.html b/doc/html/class_coord_1_1_cart_coord-members.html
@@ -0,0 +1,116 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<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.3"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>RAW-ROAM: Member List</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>
+<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>
+<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>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr id="projectrow">
+  <td id="projectalign">
+   <div id="projectname">RAW-ROAM
+   </div>
+   <div id="projectbrief">Python Re-implementation of RadarSLAM&#39;s odometry and mapping (ROAM) components</div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.9.3 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+var searchBox = new SearchBox("searchBox", "search",'Search','.html');
+/* @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');
+  $(document).ready(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">
+    <div id="nav-tree-contents">
+      <div id="nav-sync" class="sync"></div>
+    </div>
+  </div>
+  <div id="splitbar" style="-moz-user-select:none;" 
+       class="ui-resizable-handle">
+  </div>
+</div>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+$(document).ready(function(){initNavTree('class_coord_1_1_cart_coord.html',''); initResizable(); });
+/* @license-end */
+</script>
+<div id="doc-content">
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="header">
+  <div class="headertitle"><div class="title">CartCoord Member List</div></div>
+</div><!--header-->
+<div class="contents">
+
+<p>This is the complete list of members for <a class="el" href="class_coord_1_1_cart_coord.html">CartCoord</a>, including all inherited members.</p>
+<table class="directory">
+  <tr class="even"><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html#abccb4447212ff86e5d232682050b743c">__init__</a>(self, float x, float y)</td><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html">CartCoord</a></td><td class="entry"></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html#a23e8041ce1015febe4fdace3225714f9">__str__</a>(self)</td><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html">CartCoord</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html#ac158a01135b092bd40f1f52f7ba606a0">add</a>(self, float dx, float dy)</td><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html">CartCoord</a></td><td class="entry"></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html#abf0cffdf5d7c9541d7835543474cfb33">addCoord</a>(self, other)</td><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html">CartCoord</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html#a089eb0274b6e3569800bc4df2c1856a5">asTuple</a>(self)</td><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html">CartCoord</a></td><td class="entry"></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html#a5116776fb71b488b73a26117a590e4f1">getAngle</a>(self, other)</td><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html">CartCoord</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html#a52b0dfb6137418e667a29a3d6f38381f">getDistance</a>(self, other)</td><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html">CartCoord</a></td><td class="entry"></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html#ad53ca4fe02199dd659e4263dabedcbc2">getX</a>(self)</td><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html">CartCoord</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html#aab0c980e953aa02722d5d985aeba649f">getY</a>(self)</td><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html">CartCoord</a></td><td class="entry"></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html#ab59c8af84ef521a147c726904703c8b0">scale</a>(self, float scaleFactor)</td><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html">CartCoord</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html#af98adc2273ee467719863568b65d1294">scaleX</a>(self, float scaleFactor)</td><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html">CartCoord</a></td><td class="entry"></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html#a3eb779a8ba87a0bfcff18d97a54abed4">scaleY</a>(self, float scaleFactor)</td><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html">CartCoord</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html#acc3259cd47f8262a8a3e65f59ee36acf">sub</a>(self, float dx, float dy)</td><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html">CartCoord</a></td><td class="entry"></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html#a9336ebf25087d91c818ee6e9ec29f8c1">x</a></td><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html">CartCoord</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html#a2fb1c5cf58867b5bbc9a1b145a86f3a0">y</a></td><td class="entry"><a class="el" href="class_coord_1_1_cart_coord.html">CartCoord</a></td><td class="entry"></td></tr>
+</table></div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="footer">Generated on Thu May 5 2022 00:51:38 for RAW-ROAM by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 </li>
+  </ul>
+</div>
+</body>
+</html>