Merge pull request #2 from libdriver/dev

fix: fix doc errors

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.0.2 (2024-12-21)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.1 (2024-08-10)
 
 ## Bug Fixes

doc/html/group__qmc5883l__base__driver.html

@@ -429,7 +429,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa4538737baf0372a0ea212c
 <p>close the chip </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 a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -476,8 +476,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga45556c65bae5027c4c66acd
 <p>get the full scale </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 a qmc5883l handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*scale</td><td>points to a full scale buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*scale</td><td>pointer to a full scale buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -523,8 +523,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga67b6d20df29fff88267935d
 <p>get 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 a qmc5883l handle structure </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 a qmc5883l handle structure </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>
@@ -570,8 +570,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaea5817032ac5820dc674b23
 <p>get the chip mode </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 a qmc5883l handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*mode</td><td>points to a chip mode buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*mode</td><td>pointer to a chip mode buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -617,8 +617,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga992118884d7475454a07439
 <p>get the output rate </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 a qmc5883l handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*rate</td><td>points to an output rate buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*rate</td><td>pointer to an output rate buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -664,8 +664,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3c7c3acd58f42ff14d18900
 <p>get the over sample </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 a qmc5883l handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*sample</td><td>points to an over sample buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*sample</td><td>pointer to an over sample buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -711,8 +711,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga48965121cdc5398c007c99b
 <p>get period </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 a qmc5883l handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*fbr</td><td>points to a param buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*fbr</td><td>pointer to a param buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -758,8 +758,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga15e9b2d8bfca94339c2ff59
 <p>get pointer roll over 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 a qmc5883l handle structure </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 a qmc5883l handle structure </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>
@@ -805,8 +805,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga7da605d26f3c4439ea2b045
 <p>get 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 a qmc5883l handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*status</td><td>points to a status buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*status</td><td>pointer to a status buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -842,7 +842,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga896447d6e73b31d4138b630
 <p>get chip's information </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>points to a qmc5883l info structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>pointer to a qmc5883l info structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -876,7 +876,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga69435d57b572792c0d956a7
 <p>initialize the chip </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 a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -930,9 +930,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga0498c73b2dd9281b6c8268e
 <p>read data </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 a qmc5883l handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>points to a raw data buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*m_gauss</td><td>points to a converted data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>pointer to a raw data buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*m_gauss</td><td>pointer to a converted data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -984,9 +984,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa26e62a284e9f8c19b608e1
 <p>read temperature </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 a qmc5883l handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>points to a raw data buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*deg</td><td>points to a converted data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>pointer to a raw data buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*deg</td><td>pointer to a converted data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -1032,8 +1032,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga03a4a44629e3f7724443deb
 <p>set the full scale </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 a qmc5883l handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">scale</td><td>is the set full scale </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">scale</td><td>set full scale </td></tr>
   </table>
   </dd>
 </dl>
@@ -1079,8 +1079,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga8624cf3e4c40a1077ddfcc5
 <p>enable or disable 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 a qmc5883l handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>is a bool value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>bool value </td></tr>
   </table>
   </dd>
 </dl>
@@ -1126,8 +1126,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf72b0c3b9d5bfbf90a713e8
 <p>set the chip mode </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 a qmc5883l handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>is the chip mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>chip mode </td></tr>
   </table>
   </dd>
 </dl>
@@ -1173,8 +1173,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab4f18da7ec24f7ba9a7187f
 <p>set the output rate </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 a qmc5883l handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">rate</td><td>is the output rate </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">rate</td><td>output rate </td></tr>
   </table>
   </dd>
 </dl>
@@ -1220,8 +1220,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4ef51c20ec0f5b0d1481441
 <p>set the over sample </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 a qmc5883l handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">sample</td><td>is the over sample </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">sample</td><td>over sample </td></tr>
   </table>
   </dd>
 </dl>
@@ -1267,8 +1267,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga8d0e0c125a92deb21b60fdf
 <p>set period </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 a qmc5883l handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">fbr</td><td>is the set param </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">fbr</td><td>set param </td></tr>
   </table>
   </dd>
 </dl>
@@ -1314,8 +1314,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga76cbfe4f4a9dccb87686d1a
 <p>enable or disable pointer roll over </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 a qmc5883l handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>is a bool value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>bool value </td></tr>
   </table>
   </dd>
 </dl>
@@ -1351,7 +1351,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad8ef3e412cc24cfce6a64b4
 <p>soft reset </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 a qmc5883l handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__qmc5883l__example__driver.html

@@ -306,7 +306,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gafd4f745ee64bf168aeb51a2
 <p>basic example read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*m_gauss</td><td>points to a converted data buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*m_gauss</td><td>pointer to a converted data buffer </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__qmc5883l__extend__driver.html

@@ -147,10 +147,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaff0194f343fb242ea826c86
 <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 a qmc5883l handle structure </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 data buffer length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </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>data buffer length </td></tr>
   </table>
   </dd>
 </dl>
@@ -208,10 +208,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga7f6ec7a634783cd5fe6f987
 <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 a qmc5883l handle structure </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 data buffer length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a qmc5883l handle structure </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>data buffer length </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__qmc5883l__interface__driver.html

@@ -147,7 +147,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab5f6babe2faf77868d2374d
 <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>
@@ -176,7 +176,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga7ec4137f336821af1ca3d76
 <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>
@@ -283,10 +283,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga7ae926296855c213c120c35
 <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>
@@ -342,10 +342,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga40c4cb3dd9f714fae11c727
 <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>