Skip to content

Commit

Permalink
First implementation of Doxygen generation
Browse files Browse the repository at this point in the history 
-created Doxyfile with configuration to extract all even if not
documented
-generated the html folder only for Esp32, libs are excluded
-created a .lnk file pointing to index.html inside the Arduino folder
  • Loading branch information
@bbogdanmircea
bbogdanmircea committed Aug 14, 2023
1 parent ae682c3 commit d71bbbe
Show file tree
Hide file tree
Showing 334 changed files with 24,778 additions and 0 deletions.
Binary file added Arduino/doxygen_documentation.lnk
View file
Binary file not shown.
139 changes: 139 additions & 0 deletions Arduino/html/_a_b_s_oscillation_8h.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
<!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" lang="en-US">
<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.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DIY-Sim-Racing-Active-Pedal: Arduino/Esp32/Main/ABSOscillation.h 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>
<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">DIY-Sim-Racing-Active-Pedal<span id="projectnumber">&#160;Version 1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<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" 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>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a991eec27578c865874ede3d8ec657c2.html">Arduino</a></li><li class="navelem"><a class="el" href="dir_f52bce153a8348712d9d1194ad827d81.html">Esp32</a></li><li class="navelem"><a class="el" href="dir_c573df82022f43a397e0d6371dae90ff.html">Main</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">ABSOscillation.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="_diy_active_pedal__types_8h_source.html">DiyActivePedal_types.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for ABSOscillation.h:</div>
<div class="dyncontent">
<div class="center"><img src="_a_b_s_oscillation_8h__incl.png" border="0" usemap="#a_arduino_2_esp32_2_main_2_a_b_s_oscillation_8h" alt=""/></div>
<map name="a_arduino_2_esp32_2_main_2_a_b_s_oscillation_8h" id="a_arduino_2_esp32_2_main_2_a_b_s_oscillation_8h">
<area shape="rect" title=" " alt="" coords="15,5,154,48"/>
<area shape="rect" href="_diy_active_pedal__types_8h.html" title=" " alt="" coords="5,96,164,123"/>
<area shape="poly" title=" " alt="" coords="87,49,87,81,82,81,82,49"/>
<area shape="rect" title=" " alt="" coords="52,171,117,197"/>
<area shape="poly" title=" " alt="" coords="87,123,87,156,82,156,82,123"/>
</map>
</div>
</div>
<p><a href="_a_b_s_oscillation_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_b_s_oscillation.html">ABSOscillation</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="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a61ab862323b75936acb10c28e7079bb2"><td class="memItemLeft" align="right" valign="top">static const long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_a_b_s_oscillation_8h.html#a61ab862323b75936acb10c28e7079bb2">ABS_ACTIVE_TIME_PER_TRIGGER_MILLIS</a> = 100</td></tr>
<tr class="separator:a61ab862323b75936acb10c28e7079bb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a61ab862323b75936acb10c28e7079bb2" name="a61ab862323b75936acb10c28e7079bb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61ab862323b75936acb10c28e7079bb2">&#9670;&#160;</a></span>ABS_ACTIVE_TIME_PER_TRIGGER_MILLIS</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const long ABS_ACTIVE_TIME_PER_TRIGGER_MILLIS = 100</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_a_b_s_oscillation_8h_source.html#l00006">6</a> of file <a class="el" href="_a_b_s_oscillation_8h_source.html">ABSOscillation.h</a>.</p>

</div>
</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.7
</small></address>
</body>
</html>
7 changes: 7 additions & 0 deletions Arduino/html/_a_b_s_oscillation_8h__incl.map
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<map id="Arduino/Esp32/Main/ABSOscillation.h" name="Arduino/Esp32/Main/ABSOscillation.h">
<area shape="rect" id="Node000001" title=" " alt="" coords="15,5,154,48"/>
<area shape="rect" id="Node000002" href="$_diy_active_pedal__types_8h.html" title=" " alt="" coords="5,96,164,123"/>
<area shape="poly" id="edge1_Node000001_Node000002" title=" " alt="" coords="87,49,87,81,82,81,82,49"/>
<area shape="rect" id="Node000003" title=" " alt="" coords="52,171,117,197"/>
<area shape="poly" id="edge2_Node000002_Node000003" title=" " alt="" coords="87,123,87,156,82,156,82,123"/>
</map>
1 change: 1 addition & 0 deletions Arduino/html/_a_b_s_oscillation_8h__incl.md5
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
b1be839767eaa2d2d27a3dc6f60582e0
Binary file added Arduino/html/_a_b_s_oscillation_8h__incl.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit d71bbbe

Please sign in to comment.