Merge pull request #8 from libdriver/dev

fix: fix doc errors

CHANGELOG.md

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

doc/html/group__sgp41__algorithm.html

@@ -233,8 +233,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4184c4381d1c0bd993513dc
 <p>algorithm get sampling interval </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>points to an sgp41 gas index algorithm handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*sampling_interval</td><td>points to a sampling interval buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>pointer to an sgp41 gas index algorithm handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*sampling_interval</td><td>pointer to a sampling interval buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -278,9 +278,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3dd6d5c0468943084af2b16
 <p>algorithm get states </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>points to an sgp41 gas index algorithm handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*state0</td><td>points to a state0 buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*state1</td><td>points to a state1 buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>pointer to an sgp41 gas index algorithm handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*state0</td><td>pointer to a state0 buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*state1</td><td>pointer to a state1 buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -348,13 +348,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa0231578487580e657a4ae4
 <p>algorithm get tuning parameters </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>points to an sgp41 gas index algorithm handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*index_offset</td><td>points to a index offset buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*learning_time_offset_hours</td><td>points to a learning time offset hours buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*learning_time_gain_hours</td><td>points to a learning time gain hours buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*gating_max_duration_minutes</td><td>points to a gating max duration minutes buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*std_initial</td><td>points to a std initial buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*gain_factor</td><td>points to a gain factor buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>pointer to an sgp41 gas index algorithm handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*index_offset</td><td>pointer to a index offset buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*learning_time_offset_hours</td><td>pointer to a learning time offset hours buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*learning_time_gain_hours</td><td>pointer to a learning time gain hours buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*gating_max_duration_minutes</td><td>pointer to a gating max duration minutes buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*std_initial</td><td>pointer to a std initial buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*gain_factor</td><td>pointer to a gain factor buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -392,8 +392,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga86f29f256abc9717901c3c7
 <p>algorithm init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>points to an sgp41 gas index algorithm handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">algorithm_type</td><td>is the algorithm type </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>pointer to an sgp41 gas index algorithm handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">algorithm_type</td><td>algorithm type </td></tr>
   </table>
   </dd>
 </dl>
@@ -437,9 +437,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga76c67644940e36c689b8560
 <p>algorithm init with sampling interval </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>points to an sgp41 gas index algorithm handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">algorithm_type</td><td>is the algorithm type </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">sampling_interval</td><td>is the sampling interval </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>pointer to an sgp41 gas index algorithm handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">algorithm_type</td><td>algorithm type </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">sampling_interval</td><td>sampling interval </td></tr>
   </table>
   </dd>
 </dl>
@@ -483,9 +483,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3823146a04388e5498b8831
 <p>algorithm process </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>points to an sgp41 gas index algorithm handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">sraw</td><td>is the source raw </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*gas_index</td><td>points to a gas index buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>pointer to an sgp41 gas index algorithm handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">sraw</td><td>source raw </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*gas_index</td><td>pointer to a gas index buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -513,7 +513,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gacd62a5a3e96451c1f91fcb8
 <p>algorithm reset </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>points to an sgp41 gas index algorithm handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>pointer to an sgp41 gas index algorithm handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -557,9 +557,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaef1772c995c1b2111918162
 <p>algorithm set states </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>points to an sgp41 gas index algorithm handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">state0</td><td>is the set state0 </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">state1</td><td>is the set state1 </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>pointer to an sgp41 gas index algorithm handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">state0</td><td>set state0 </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">state1</td><td>set state1 </td></tr>
   </table>
   </dd>
 </dl>
@@ -627,13 +627,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga36b55b2166e50039ebd486d
 <p>algorithm set tuning parameters </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>points to an sgp41 gas index algorithm handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">index_offset</td><td>is the index offset </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">learning_time_offset_hours</td><td>is the learning time offset hours </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">learning_time_gain_hours</td><td>is the learning time gain hours </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">gating_max_duration_minutes</td><td>is the gating max duration minutes </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">std_initial</td><td>is the std initial </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">gain_factor</td><td>is the gain factor </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*params</td><td>pointer to an sgp41 gas index algorithm handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">index_offset</td><td>index offset </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">learning_time_offset_hours</td><td>learning time offset hours </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">learning_time_gain_hours</td><td>learning time gain hours </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">gating_max_duration_minutes</td><td>gating max duration minutes </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">std_initial</td><td>std initial </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">gain_factor</td><td>gain factor </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__sgp41__base__driver.html

@@ -208,7 +208,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga42c93b6a7e8e245f465fdb6
 <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 an sgp41 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an sgp41 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -255,8 +255,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2789b5ef93fffa7775724a6
 <p>get execute conditioning </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 sgp41 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*sraw_voc</td><td>points to a raw tvoc buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an sgp41 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*sraw_voc</td><td>pointer to a raw tvoc buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -320,11 +320,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga21067f4b4b35dde4f24f930
 <p>get the measure raw result </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 sgp41 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">raw_humidity</td><td>is the humidity raw data </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">raw_temperature</td><td>is the temperature raw data </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*sraw_voc</td><td>points to a raw tvoc buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*sraw_nox</td><td>points to a raw nox buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an sgp41 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">raw_humidity</td><td>humidity raw data </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">raw_temperature</td><td>temperature raw data </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*sraw_voc</td><td>pointer to a raw tvoc buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*sraw_nox</td><td>pointer to a raw nox buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -376,9 +376,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gadcf95da935d518d4d98a1a5
 <p>get the measure raw result without compensation </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 sgp41 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*sraw_voc</td><td>points to a raw tvoc buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*sraw_nox</td><td>points to a raw nox buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an sgp41 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*sraw_voc</td><td>pointer to a raw tvoc buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*sraw_nox</td><td>pointer to a raw nox buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -424,8 +424,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa2d7469a7bc5e7a0a9cece7
 <p>get the chip measure test </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 sgp41 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*result</td><td>points to a test result buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an sgp41 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*result</td><td>pointer to a test result buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -471,8 +471,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad29092b1a5e48359f954dec
 <p>get the chip serial id </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 sgp41 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*id</td><td>points to an id buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an sgp41 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*id</td><td>pointer to an id buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -524,9 +524,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaea40380fadab9668a1b15c4
 <p>convert the humidity to the register 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 an sgp41 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">rh</td><td>is the current relative humidity </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*reg</td><td>points to a converted register data </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an sgp41 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">rh</td><td>current relative humidity </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*reg</td><td>pointer to a converted register data </td></tr>
   </table>
   </dd>
 </dl>
@@ -562,7 +562,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3ec0aa22b8268b2846b7805
 <p>get chip 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 an sgp41 info structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>pointer to an sgp41 info structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -596,7 +596,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad8a732a0dfd04076ae6965b
 <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 an sgp41 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an sgp41 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -632,7 +632,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gacaf07e30ed9cc57d2cf3b22
 <p>soft reset 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 an sgp41 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an sgp41 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -684,9 +684,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga17dee55ccc6c019504406a3
 <p>convert the temperature to the register 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 an sgp41 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">temp</td><td>is the current temperature </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*reg</td><td>points to a converted register data </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an sgp41 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">temp</td><td>current temperature </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*reg</td><td>pointer to a converted register data </td></tr>
   </table>
   </dd>
 </dl>
@@ -722,7 +722,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gabc84e7432b7c7611ff72d30
 <p>turn heater off </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 sgp41 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an sgp41 handle structure </td></tr>
   </table>
   </dd>
 </dl>