added doxygen (incomplete) docs

ebertolazzi · Feb 19, 2021 · f25ae50 · f25ae50
1 parent 5d2d189
commit f25ae50
Show file tree

Hide file tree

Showing 516 changed files with 61,434 additions and 1 deletion.
diff --git a/Doxyfile b/Doxyfile
@@ -813,7 +813,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = src
+INPUT                  = src src/Clothoids submodules/GenericContainer/src submodules/Utils/src submodules/Utils/src/Utils  submodules/quarticRootsFlocke/src
 
 # 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

diff --git a/docs/annotated.html b/docs/annotated.html
diff --git a/docs/bc_s.png b/docs/bc_s.png
diff --git a/docs/bdwn.png b/docs/bdwn.png
diff --git a/docs/classes.html b/docs/classes.html
@@ -0,0 +1,122 @@
+<!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=9"/>
+<meta name="generator" content="Doxygen 1.9.1"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Clothoids: Class Index</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="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/x-mathjax-config">
+  MathJax.Hub.Config({
+    extensions: ["tex2jax.js"],
+    jax: ["input/TeX","output/HTML-CSS"],
+});
+</script>
+<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.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 style="height: 56px;">
+  <td id="projectlogo"><img alt="Logo" src="logo.pdf"/></td>
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">Clothoids
+   </div>
+   <div id="projectbrief">Clothoids: a library for line, circle, clothoids and more</div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.9.1 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+/* @license-end */</script>
+<div id="main-nav"></div>
+</div><!-- top -->
+<!-- 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 Index</div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="qindex"><a class="qindex" href="#letter_A">A</a>&#160;|&#160;<a class="qindex" href="#letter_B">B</a>&#160;|&#160;<a class="qindex" href="#letter_C">C</a>&#160;|&#160;<a class="qindex" href="#letter_G">G</a>&#160;|&#160;<a class="qindex" href="#letter_L">L</a>&#160;|&#160;<a class="qindex" href="#letter_M">M</a>&#160;|&#160;<a class="qindex" href="#letter_P">P</a>&#160;|&#160;<a class="qindex" href="#letter_Q">Q</a>&#160;|&#160;<a class="qindex" href="#letter_R">R</a>&#160;|&#160;<a class="qindex" href="#letter_S">S</a>&#160;|&#160;<a class="qindex" href="#letter_T">T</a>&#160;|&#160;<a class="qindex" href="#letter_W">W</a></div>
+<div class="classindex">
+<dl class="classindex even">
+<dt class="alphachar"><a name="letter_A">A</a></dt>
+<dd><a class="el" href="d5/d1e/class_g2lib_1_1_a_a_b_btree.html">AABBtree</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd><dd><a class="el" href="d2/d79/class_g2lib_1_1_asy_plot.html">AsyPlot</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd></dl>
+<dl class="classindex odd">
+<dt class="alphachar"><a name="letter_B">B</a></dt>
+<dd><a class="el" href="d8/d20/class_utils_1_1_barrier.html">Barrier</a> (<a class="el" href="d1/d7c/namespace_utils.html">Utils</a>)</dd><dd><a class="el" href="d2/d03/class_g2lib_1_1_base_curve.html">BaseCurve</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd><dd><a class="el" href="de/d56/class_g2lib_1_1_b_box.html">BBox</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd><dd><a class="el" href="dd/dd4/class_g2lib_1_1_biarc.html">Biarc</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd><dd><a class="el" href="df/d29/class_g2lib_1_1_biarc_list.html">BiarcList</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd><dd><a class="el" href="d9/d96/class_utils_1_1_binary_search.html">BinarySearch</a> (<a class="el" href="d1/d7c/namespace_utils.html">Utils</a>)</dd></dl>
+<dl class="classindex even">
+<dt class="alphachar"><a name="letter_C">C</a></dt>
+<dd><a class="el" href="d6/d33/structc__complex__type.html">c_complex_type</a></dd><dd><a class="el" href="d7/dd9/class_g2lib_1_1_circle_arc.html">CircleArc</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd><dd><a class="el" href="dc/d27/class_g2lib_1_1_clothoid_curve.html">ClothoidCurve</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd><dd><a class="el" href="dc/d5d/class_g2lib_1_1_clothoid_data.html">ClothoidData</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd><dd><a class="el" href="d7/d02/class_g2lib_1_1_clothoid_list.html">ClothoidList</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd><dd><a class="el" href="df/d4a/class_g2lib_1_1_clothoid_spline_g2.html">ClothoidSplineG2</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd><dd><a class="el" href="d1/df8/class_utils_1_1_console.html">Console</a> (<a class="el" href="d1/d7c/namespace_utils.html">Utils</a>)</dd><dd><a class="el" href="dd/d68/class_utils_1_1_console_1_1_console__style.html">Console::Console_style</a> (<a class="el" href="d1/d7c/namespace_utils.html">Utils</a>)</dd><dd><a class="el" href="d9/df7/class_polynomial_roots_1_1_cubic.html">Cubic</a> (<a class="el" href="d5/d44/namespace_polynomial_roots.html">PolynomialRoots</a>)</dd></dl>
+<dl class="classindex odd">
+<dt class="alphachar"><a name="letter_G">G</a></dt>
+<dd><a class="el" href="da/da5/class_g2lib_1_1_g2solve2arc.html">G2solve2arc</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd><dd><a class="el" href="d1/dec/class_g2lib_1_1_g2solve3arc.html">G2solve3arc</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd><dd><a class="el" href="da/dda/class_g2lib_1_1_g2solve_c_l_c.html">G2solveCLC</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd><dd><a class="el" href="de/dfa/class_generic_container_namespace_1_1_generic_container.html">GenericContainer</a> (GenericContainerNamespace)</dd><dd><a class="el" href="d1/df7/class_generic_container_namespace_1_1_generic_container_explorer.html">GenericContainerExplorer</a> (GenericContainerNamespace)</dd></dl>
+<dl class="classindex even">
+<dt class="alphachar"><a name="letter_L">L</a></dt>
+<dd><a class="el" href="d9/d0c/class_g2lib_1_1_line_segment.html">LineSegment</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd></dl>
+<dl class="classindex odd">
+<dt class="alphachar"><a name="letter_M">M</a></dt>
+<dd><a class="el" href="dc/d87/class_utils_1_1_malloc.html">Malloc</a> (<a class="el" href="d1/d7c/namespace_utils.html">Utils</a>)</dd><dd><a class="el" href="d5/de4/class_generic_container_namespace_1_1mat__type.html">mat_type</a> (GenericContainerNamespace)</dd></dl>
+<dl class="classindex even">
+<dt class="alphachar"><a name="letter_P">P</a></dt>
+<dd><a class="el" href="d2/d00/class_g2lib_1_1_poly_line.html">PolyLine</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd></dl>
+<dl class="classindex odd">
+<dt class="alphachar"><a name="letter_Q">Q</a></dt>
+<dd><a class="el" href="d5/ded/class_polynomial_roots_1_1_quadratic.html">Quadratic</a> (<a class="el" href="d5/d44/namespace_polynomial_roots.html">PolynomialRoots</a>)</dd><dd><a class="el" href="d8/dec/class_polynomial_roots_1_1_quartic.html">Quartic</a> (<a class="el" href="d5/d44/namespace_polynomial_roots.html">PolynomialRoots</a>)</dd></dl>
+<dl class="classindex even">
+<dt class="alphachar"><a name="letter_R">R</a></dt>
+<dd><a class="el" href="db/d6b/class_utils_1_1_runtime___error.html">Runtime_Error</a> (<a class="el" href="d1/d7c/namespace_utils.html">Utils</a>)</dd><dd><a class="el" href="d8/d7d/class_utils_1_1_runtime___trace_error.html">Runtime_TraceError</a> (<a class="el" href="d1/d7c/namespace_utils.html">Utils</a>)</dd></dl>
+<dl class="classindex odd">
+<dt class="alphachar"><a name="letter_S">S</a></dt>
+<dd><a class="el" href="d5/d81/class_utils_1_1_simple_semaphore.html">SimpleSemaphore</a> (<a class="el" href="d1/d7c/namespace_utils.html">Utils</a>)</dd><dd><a class="el" href="df/d84/class_g2lib_1_1_solve2x2.html">Solve2x2</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd><dd><a class="el" href="d4/d63/class_utils_1_1_spin_lock.html">SpinLock</a> (<a class="el" href="d1/d7c/namespace_utils.html">Utils</a>)</dd><dd><a class="el" href="d3/d23/class_utils_1_1_spin_lock__barrier.html">SpinLock_barrier</a> (<a class="el" href="d1/d7c/namespace_utils.html">Utils</a>)</dd></dl>
+<dl class="classindex even">
+<dt class="alphachar"><a name="letter_T">T</a></dt>
+<dd><a class="el" href="d2/d25/class_utils_1_1_thread_pool.html">ThreadPool</a> (<a class="el" href="d1/d7c/namespace_utils.html">Utils</a>)</dd><dd><a class="el" href="d7/df9/class_utils_1_1_tic_toc.html">TicToc</a> (<a class="el" href="d1/d7c/namespace_utils.html">Utils</a>)</dd><dd><a class="el" href="d8/d7c/class_g2lib_1_1_triangle2_d.html">Triangle2D</a> (<a class="el" href="d4/d9f/namespace_g2lib.html">G2lib</a>)</dd></dl>
+<dl class="classindex odd">
+<dt class="alphachar"><a name="letter_W">W</a></dt>
+<dd><a class="el" href="d6/dde/class_utils_1_1_wait_worker.html">WaitWorker</a> (<a class="el" href="d1/d7c/namespace_utils.html">Utils</a>)</dd><dd><a class="el" href="d4/d23/class_utils_1_1_worker.html">Worker</a> (<a class="el" href="d1/d7c/namespace_utils.html">Utils</a>)</dd></dl>
+</div>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
+</small></address>
+</body>
+</html>
diff --git a/docs/closed.png b/docs/closed.png