Merge pull request #30 from libdriver/dev

fix: fix doc errors

Author: libdriver

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.0.4 (2024-12-19)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.3 (2024-08-15)
 
 ## Bug Fixes

doc/html/group__mpu6050__basic__driver.html

@@ -1507,7 +1507,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga25caa65e97f5d7469be240f
 <p>basic example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <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">addr_pin</td><td>iic device address </td></tr>
   </table>
   </dd>
 </dl>
@@ -1549,8 +1549,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga92b4964e6a8ef6b228c414e
 <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">*dps</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>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*dps</td><td>pointer to a converted data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -1582,7 +1582,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga105b3437eaeddcdf860357a
 <p>basic example read temperature </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*degrees</td><td>points to a converted data buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*degrees</td><td>pointer to a converted data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -1640,7 +1640,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga5dc2e5196128effa5c85ca0
 <p>dmp example get pedometer counter </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*cnt</td><td>points to a cnt buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*cnt</td><td>pointer to a cnt buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -1694,10 +1694,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3298a755f9974bc3b2376ef
 <p>dmp example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <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">*receive_callback</td><td>points to a receive callback function </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*tap_callback</td><td>points to a tap callback function </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*orient_callback</td><td>points to an orient callback function </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">*receive_callback</td><td>pointer to a receive callback function </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*tap_callback</td><td>pointer to a tap callback function </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*orient_callback</td><td>pointer to an orient callback function </td></tr>
   </table>
   </dd>
 </dl>
@@ -1807,15 +1807,15 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa5f0a1219f072e02cd4c9bd
 <p>dmp example read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*accel_raw</td><td>points to an accel raw buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*accel_g</td><td>points to an accel g buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*gyro_raw</td><td>points to a gyro raw buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*gyro_dps</td><td>points to a gyro dps buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*quat</td><td>points to a quat buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*pitch</td><td>points to a pitch buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*roll</td><td>points to a roll buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*yaw</td><td>points to a yaw buffer </td></tr>
-    <tr><td class="paramdir">[in,out]</td><td class="paramname">*l</td><td>points to a length buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*accel_raw</td><td>pointer to an accel raw buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*accel_g</td><td>pointer to an accel g buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*gyro_raw</td><td>pointer to a gyro raw buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*gyro_dps</td><td>pointer to a gyro dps buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*quat</td><td>pointer to a quat buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*pitch</td><td>pointer to a pitch buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*roll</td><td>pointer to a roll buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*yaw</td><td>pointer to a yaw buffer </td></tr>
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">*l</td><td>pointer to a length buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -1873,7 +1873,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga94ff83e8f03f79ee9afef16
 <p>fifo example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <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">addr_pin</td><td>iic device address </td></tr>
   </table>
   </dd>
 </dl>
@@ -1959,11 +1959,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga99b36870704b18e3be5045e
 <p>fifo example read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">**accel_raw</td><td>points to an accel raw data buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">**accel_g</td><td>points to a converted accel data buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">**gyro_raw</td><td>points to an gyro raw data buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">**gyro_dps</td><td>points to a converted gyro data buffer </td></tr>
-    <tr><td class="paramdir">[in,out]</td><td class="paramname">*len</td><td>points to a length buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">**accel_raw</td><td>pointer to an accel raw data buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">**accel_g</td><td>pointer to a converted accel data buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">**gyro_raw</td><td>pointer to an gyro raw data buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">**gyro_dps</td><td>pointer to a converted gyro data buffer </td></tr>
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">*len</td><td>pointer to a length buffer </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__mpu6050__dmp__driver.html

@@ -147,10 +147,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3d573edea87552d3af6d4e6
 <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 mpu6050 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 mpu6050 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>data buffer length </td></tr>
   </table>
   </dd>
 </dl>
@@ -206,10 +206,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga40023d18b00ff046ebd5acc
 <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 mpu6050 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 mpu6050 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>data buffer length </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__mpu6050__example__driver.html

@@ -156,7 +156,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga766f67d9a4579de12f96622
 <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>
@@ -183,7 +183,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaff78feee028c344ef7da403
 <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>
@@ -210,7 +210,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4885b5ea879f63878c1cb8c
 <p>interface dmp orient callback </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">orientation</td><td>is the dmp orientation </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">orientation</td><td>dmp orientation </td></tr>
   </table>
   </dd>
 </dl>
@@ -247,8 +247,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga15f00112e11f9787ed2e532
 <p>interface dmp tap callback </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>is the tap count </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">direction</td><td>is the tap direction </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>tap count </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">direction</td><td>tap direction </td></tr>
   </table>
   </dd>
 </dl>
@@ -349,10 +349,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga5ed51358859988d3b6168c1
 <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>
@@ -406,10 +406,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaddddbfa804e2824445fea96
 <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>
@@ -441,7 +441,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf09d98bce66f648d644cfe9
 <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>

doc/html/group__mpu6050__extern__driver.html

@@ -153,8 +153,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga63867eb6e3e0e8b6eb9db96
 <p>link debug_print function </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 mpu6050 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a debug_print function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an mpu6050 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a debug_print function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -191,8 +191,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4fea7149d25ab87d8f6c80e
 <p>link delay_ms function </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 mpu6050 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a delay_ms function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an mpu6050 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a delay_ms function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -229,8 +229,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3d09d336b1613c2c4a2e4c0
 <p>link iic_deinit function </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 mpu6050 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an iic_deinit function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an mpu6050 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an iic_deinit function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -267,8 +267,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gafabd528b60d16bfe5266db9
 <p>link iic_init function </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 mpu6050 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an iic_init function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an mpu6050 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an iic_init function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -305,8 +305,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaea7651083f5094d743da950
 <p>link iic_read function </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 mpu6050 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an iic_read function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an mpu6050 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an iic_read function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -343,8 +343,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga496e0e45719d3440e3490dd
 <p>link iic_write function </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 mpu6050 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an iic_write function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an mpu6050 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an iic_write function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -381,8 +381,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga46dbd25662816592440e74f
 <p>initialize mpu6050_handle_t structure </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 mpu6050 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>is mpu6050_handle_t </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an mpu6050 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>mpu6050_handle_t </td></tr>
   </table>
   </dd>
 </dl>
@@ -419,8 +419,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gabed3b0caba4d09b9429cdc1
 <p>link receive_callback function </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 mpu6050 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a receive_callback function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an mpu6050 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a receive_callback function address </td></tr>
   </table>
   </dd>
 </dl>