Merge pull request #22 from libdriver/dev

fix: fix doc errors

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.0.2 (2024-11-29)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 2.0.1 (2024-08-05)
 
 ## Bug Fixes

doc/html/group__adxl345__example__driver.html

@@ -2253,8 +2253,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaef509cbc3ca31c1d758ce6c
 <p>basic example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>is the chip interface </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>is the iic device address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>chip interface </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>iic device address </td></tr>
   </table>
   </dd>
 </dl>
@@ -2288,7 +2288,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga73f16fc9dd675f3914750f9
 <p>basic example read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*g</td><td>points to a converted data buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*g</td><td>pointer to a converted data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -2366,9 +2366,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga61e623471c5b5e96b08067a
 <p>fifo example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>is the chip interface </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>is the iic device address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*callback</td><td>points to a irq callback address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>chip interface </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>iic device address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*callback</td><td>pointer to an irq callback address </td></tr>
   </table>
   </dd>
 </dl>
@@ -2498,13 +2498,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga5e4d1a9c4a6f26158f98028
 <p>interrupt example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>is the chip interface </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>is the iic device address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*callback</td><td>points to a irq callback address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">tap_enable</td><td>is the tap enable bool value </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">action_enable</td><td>is the action enable bool value </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">inaction_enable</td><td>is the inaction enable bool value </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">fall_enable</td><td>is the fall enable bool value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>chip interface </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>iic device address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*callback</td><td>pointer to an irq callback address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">tap_enable</td><td>bool value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">action_enable</td><td>bool value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">inaction_enable</td><td>bool value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">fall_enable</td><td>bool value </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__adxl345__extern__driver.html

@@ -147,10 +147,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga400b41a1b9f0e7b2b8efb65
 <p>get the chip register </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>points to an adxl345 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is the register address </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*buf</td><td>points to a data buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the data buffer length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an adxl345 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>register address </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*buf</td><td>pointer to a data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>length of data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -208,10 +208,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga73234553f77d29af76f5887
 <p>set the chip register </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>points to an adxl345 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is the register address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*buf</td><td>points to a data buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the data buffer length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an adxl345 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>register address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*buf</td><td>pointer to a data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>length of data buffer </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__adxl345__fifo__driver.html

@@ -138,8 +138,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3951f4583cfaeda6c300b79
 <p>get the fifo watermark </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>points to an adxl345 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*level</td><td>points to a watermark level buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an adxl345 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*level</td><td>pointer to a watermark level buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -185,8 +185,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab02a914bb33b35d2735aed4
 <p>get the current fifo watermark level </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>points to an adxl345 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*level</td><td>points to a current watermark level buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an adxl345 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*level</td><td>pointer to a current watermark level buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -232,8 +232,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gadb751a0438496cb126f842a
 <p>set the fifo watermark </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>points to an adxl345 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>is the watermark level </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an adxl345 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>watermark level </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__adxl345__interface__driver.html

@@ -162,7 +162,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaed01257842a132903de66b9
 <p>interface print format data </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td>is the format data </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td>format data </td></tr>
   </table>
   </dd>
 </dl>
@@ -191,7 +191,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae97a2f5d9ddfa24d97e3239
 <p>interface delay ms </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">ms</td><td></td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">ms</td><td>time </td></tr>
   </table>
   </dd>
 </dl>
@@ -298,10 +298,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac04b27bf31395054d403a3a
 <p>interface iic bus read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>is the iic device write address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is the iic register address </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*buf</td><td>points to a data buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the length of the data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>iic device write address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>iic register address </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*buf</td><td>pointer to a data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>length of the data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -357,10 +357,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3b51e236ac0c135b3926f77
 <p>interface iic bus write </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>is the iic device write address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is the iic register address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*buf</td><td>points to a data buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the length of the data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>iic device write address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>iic register address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*buf</td><td>pointer to a data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>length of the data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -394,7 +394,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab5a057203f7953a55a56640
 <p>interface receive callback </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>is the irq type </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>irq type </td></tr>
   </table>
   </dd>
 </dl>
@@ -495,9 +495,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa4ab6dda602c73a66a8770c
 <p>interface spi bus read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is the register address </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*buf</td><td>points to a data buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the length of data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>register address </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*buf</td><td>pointer to a data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>length of data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -547,9 +547,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf8299fcec0fd9740656119e
 <p>interface spi bus write </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is the register address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*buf</td><td>points to a data buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the length of data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>register address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*buf</td><td>pointer to a data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>length of data buffer </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__adxl345__interrupt__driver.html

@@ -269,9 +269,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga62a7743d57905996e2c700c
 <p>get the interrupt status </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>points to an adxl345 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>is the interrupt type </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*enable</td><td>points to a bool value buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an adxl345 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>interrupt type </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*enable</td><td>pointer to a bool value buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -317,8 +317,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga560e844cc8928ec24ce7b02
 <p>get the interrupt active level </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>points to an adxl345 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*active_level</td><td>points to an interrupt active level buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an adxl345 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*active_level</td><td>pointer to an interrupt active level buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -370,9 +370,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab6a7d18f2b46d8972299f49
 <p>get the interrupt map </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>points to an adxl345 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>is the interrupt type </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*pin</td><td>points to an interrupt pin buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an adxl345 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>interrupt type </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*pin</td><td>pointer to an interrupt pin buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -418,8 +418,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga497ec3ca98e1bb9db202bcd
 <p>get the interrupt source </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>points to an adxl345 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*source</td><td>points to an interrupt source buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an adxl345 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*source</td><td>pointer to an interrupt source buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -471,9 +471,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga5b5e2a50da60784023bfa5c
 <p>enable or disable the interrupt </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>points to an adxl345 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>is the interrupt type </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>is the bool value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an adxl345 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>interrupt type </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>bool value </td></tr>
   </table>
   </dd>
 </dl>
@@ -519,8 +519,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga99b7f52190f12b03f12ad7b
 <p>set the interrupt active level </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>points to an adxl345 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">active_level</td><td>is the interrupt active level </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an adxl345 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">active_level</td><td>interrupt active level </td></tr>
   </table>
   </dd>
 </dl>
@@ -572,9 +572,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga84737e90b88feb88ac96539
 <p>set the interrupt map </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>points to an adxl345 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>is the interrupt type </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>is the interrupt pin </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an adxl345 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>interrupt type </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>interrupt pin </td></tr>
   </table>
   </dd>
 </dl>