Merge pull request #1 from grzesiek2201/doxygen

doxygen documentation
grzesiek2201 · Oct 31, 2023 · ecda691 · ecda691
2 parents c468533 + 062c353
commit ecda691
Show file tree

Hide file tree

Showing 116 changed files with 11,750 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+Doxyfile
diff --git a/docs/html/PCA9685__servo_8h_source.html b/docs/html/PCA9685__servo_8h_source.html
diff --git a/docs/html/PCA9685__servo__driver_8h_source.html b/docs/html/PCA9685__servo__driver_8h_source.html
diff --git a/docs/html/annotated.html b/docs/html/annotated.html
@@ -0,0 +1,80 @@
+<!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>Adafruit Servo Driver Library Pi Pico: 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="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 style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">Adafruit Servo Driver Library Pi Pico
+   </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 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">
+<table class="directory">
+<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPCA9685__servo.html" target="_self">PCA9685_servo</a></td><td class="desc"></td></tr>
+<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPCA9685__servo__driver.html" target="_self">PCA9685_servo_driver</a></td><td class="desc"></td></tr>
+</table>
+</div><!-- directory -->
+</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/html/bc_s.png b/docs/html/bc_s.png
diff --git a/docs/html/bdwn.png b/docs/html/bdwn.png
diff --git a/docs/html/classPCA9685__servo-members.html b/docs/html/classPCA9685__servo-members.html
@@ -0,0 +1,107 @@
+<!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>Adafruit Servo Driver Library Pi Pico: 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="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 style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">Adafruit Servo Driver Library Pi Pico
+   </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>
+<!-- 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><!-- top -->
+<div class="header">
+  <div class="headertitle">
+<div class="title">PCA9685_servo Member List</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>This is the complete list of members for <a class="el" href="classPCA9685__servo.html">PCA9685_servo</a>, including all inherited members.</p>
+<table class="directory">
+  <tr class="even"><td class="entry"><a class="el" href="classPCA9685__servo.html#addacc5e714cfbc8e65e07fbcafea64a3">changeSpeedConstT</a>(uint64_t TConstantDuration)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0"><td class="entry"><b>getAddress</b>(void) (defined in <a class="el" href="classPCA9685__servo.html">PCA9685_servo</a>)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>getInvertMode</b>(void) (defined in <a class="el" href="classPCA9685__servo.html">PCA9685_servo</a>)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0"><td class="entry"><b>getMaxAngle</b>(void) (defined in <a class="el" href="classPCA9685__servo.html">PCA9685_servo</a>)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>getMidAngle</b>(void) (defined in <a class="el" href="classPCA9685__servo.html">PCA9685_servo</a>)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0"><td class="entry"><b>getMinAngle</b>(void) (defined in <a class="el" href="classPCA9685__servo.html">PCA9685_servo</a>)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>getMode</b>(void) (defined in <a class="el" href="classPCA9685__servo.html">PCA9685_servo</a>)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classPCA9685__servo.html#aac6a286a32b128555972db42acf525d2">getPosition</a>(void)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>getSConstantPeriod</b>(void) (defined in <a class="el" href="classPCA9685__servo.html">PCA9685_servo</a>)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0"><td class="entry"><b>getTConstantDuration</b>(void) (defined in <a class="el" href="classPCA9685__servo.html">PCA9685_servo</a>)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classPCA9685__servo.html#a8e9dd989b5a13923571afb267609e4fc">isMoving</a>(void)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classPCA9685__servo.html#a1826df3efdd53a86974109680cb7a886">loop</a>(uint64_t TEllapsed)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classPCA9685__servo.html#aee57f53ff06f70f84f7b4717d02a96da">onStartMove</a></td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classPCA9685__servo.html#a3c515cad4738142a027f5d1c6b249e2e">onStopMove</a></td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classPCA9685__servo.html#a7d5acce7e8168d13b54937745ea90813">PCA9685_servo</a>(PCA9685_servo_driver *controller, uint8_t channel, uint16_t PWMmin=104, uint16_t PWMmax=508)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classPCA9685__servo.html#a4f8b6b79d56c4d6e4704dfe0e6113020">setAddress</a>(uint16_t address)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classPCA9685__servo.html#a7f4aeb9e95033770966428e61b80e897">setAngularVelocity</a>(double angVel)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0"><td class="entry"><b>setInvertMode</b>(uint8_t invert) (defined in <a class="el" href="classPCA9685__servo.html">PCA9685_servo</a>)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>setMaxAngle</b>(int8_t angle) (defined in <a class="el" href="classPCA9685__servo.html">PCA9685_servo</a>)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0"><td class="entry"><b>setMidAngle</b>(int8_t angle) (defined in <a class="el" href="classPCA9685__servo.html">PCA9685_servo</a>)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>setMinAngle</b>(int8_t angle) (defined in <a class="el" href="classPCA9685__servo.html">PCA9685_servo</a>)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classPCA9685__servo.html#a3687aa37d2f9d680e77d994ce93b128c">setMode</a>(uint8_t Mode)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classPCA9685__servo.html#a71fc2686643dea54fb80c39914e04e2b">setPosition</a>(int8_t angle)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0"><td class="entry"><b>setRange</b>(int8_t minAngle, int8_t maxAngle) (defined in <a class="el" href="classPCA9685__servo.html">PCA9685_servo</a>)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>setRange</b>(int8_t minAngle, int8_t midAngle, int8_t maxAngle) (defined in <a class="el" href="classPCA9685__servo.html">PCA9685_servo</a>)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classPCA9685__servo.html#a35ae3860f58565f5cccbd56ddfef97a7">setRelativePosition</a>(int8_t angle)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classPCA9685__servo.html#a24df8d60fedd962555697b001446c915">setSConstantPeriod</a>(uint64_t SConstantPeriod)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classPCA9685__servo.html#ae97d3c58d0128a67f487bff97b7394d1">setTConstantDuration</a>(uint64_t TConstantDuration)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classPCA9685__servo.html#ab8e67676d8b64e56936e5d42f91ddfd2">stop</a>()</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classPCA9685__servo.html#af6203fea07186638a696375360784524">throwServo</a>(uint8_t value)</td><td class="entry"><a class="el" href="classPCA9685__servo.html">PCA9685_servo</a></td><td class="entry"></td></tr>
+</table></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>