Merge pull request #19 from libdriver/dev

fix: fix doc errors

Author: libdriver

CHANGELOG.md

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

doc/html/group__mpu9250__basic__driver.html

@@ -2338,8 +2338,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga6558a4dc3f25faccfaee646
 <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 used 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>used interface </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>iic device address </td></tr>
   </table>
   </dd>
 </dl>
@@ -2389,9 +2389,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf975cc9af81a6b611bd241e
 <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">*ut</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>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*ut</td><td>pointer to a converted data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -2425,7 +2425,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga8029e1e05a66c8e3b909772
 <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>
@@ -2487,7 +2487,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga7c3c3fe0f188fbd118415ca
 <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>
@@ -2549,11 +2549,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga13aacdcbb67e01d92dd6a8c
 <p>dmp 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 used 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">*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">interface</td><td>used 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">*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>
@@ -2667,15 +2667,15 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaaf40501da341c82d50a2d1c
 <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>
@@ -2747,8 +2747,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga40236e5a22cb50b15232f25
 <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 used 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>used interface </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>iic device address </td></tr>
   </table>
   </dd>
 </dl>
@@ -2850,13 +2850,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4d4c5b8320d9ce4a86d24d6
 <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">[out]</td><td class="paramname">**mag_raw</td><td>points to a mag raw data buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">**mag_ut</td><td>points to a converted mag 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">[out]</td><td class="paramname">**mag_raw</td><td>pointer to a mag raw data buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">**mag_ut</td><td>pointer to a converted mag 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__mpu9250__dmp__driver.html

@@ -147,10 +147,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga73b4c89e65df06d8ded9a3d
 <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 mpu9250 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 mpu9250 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>
@@ -208,10 +208,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga00744e16e94390cf65193a2
 <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 mpu9250 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 mpu9250 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__mpu9250__example__driver.html

@@ -168,7 +168,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga15e531f463207b6917de60a
 <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>
@@ -197,7 +197,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf19d808d558d778f688b5a2
 <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>
@@ -226,7 +226,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga103f34f973f1e0a49fb8c1e
 <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>
@@ -265,8 +265,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga1f1b6a2b8483ea3f713465a
 <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>
@@ -373,10 +373,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga47c6b7d290af5eab7566bee
 <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>
@@ -432,10 +432,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3c0ed7f7f0e8efcdb377e6d
 <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>
@@ -469,7 +469,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae1fdc87b6d705116bbd45cb
 <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>
@@ -570,9 +570,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga983341ffd2fc96fbf7baf5a
 <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>
@@ -622,9 +622,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2510774a0a51efa0ef71e6b
 <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>