Merge pull request #1 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.0 (2024-08-30)
 
 ## Features

doc/html/group__scd30__example__driver.html

@@ -218,8 +218,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga1dd2ca7bd3635840e9115b9
 <p>basic example get the version </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*major</td><td>points to a major buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*minor</td><td>points to a minor buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*major</td><td>pointer to a major buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*minor</td><td>pointer to a minor buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -263,8 +263,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga0a8abbef9c6887b2d678c9d
 <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">mbar</td><td>is the pressure compensation </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">mbar</td><td>pressure compensation </td></tr>
   </table>
   </dd>
 </dl>
@@ -298,7 +298,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab7779899eff31d7f4198fa5
 <p>basic example read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*data</td><td>points to a scd30_data_t structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*data</td><td>pointer to a scd30_data_t structure </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__scd30__extern__driver.html

@@ -150,10 +150,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga25730c2adf6b680f9c66000
 <p>get the chip register with iic interface </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 scd30 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 an scd30 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>
@@ -217,11 +217,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga17d113bed5b9edfc82d216b
 <p>set and get the chip register with uart interface </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 scd30 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*input</td><td>points to an input buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">in_len</td><td>is the input length </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*output</td><td>points to an output buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">out_len</td><td>is the output length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an scd30 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*input</td><td>pointer to an input buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">in_len</td><td>input length </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*output</td><td>pointer to an output buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">out_len</td><td>output length </td></tr>
   </table>
   </dd>
 </dl>
@@ -277,10 +277,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#gabe99ac6b69763a041ab1d73
 <p>set the chip register with iic interface </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 scd30 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 an scd30 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__scd30__interface__driver.html

@@ -162,7 +162,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga634b34e7eb7783fb5a08fee
 <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="#gab16dd5dac8e2a5cf23d6684
 <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>
@@ -292,9 +292,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3de55d952b14fc73889153e
 <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">[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">[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>
@@ -344,9 +344,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga1829115bc8226aaba053027
 <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">*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">*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>
@@ -474,8 +474,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga72475765725113698f20d5b
 <p>interface uart read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <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">[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>
@@ -519,8 +519,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2f80ae4b0abda802ba06209
 <p>interface uart write </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <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">*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>

doc/html/group__scd30__link__driver.html

@@ -165,8 +165,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga37f554c6448955517c39709
 <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 scd30 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 scd30 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>
@@ -205,8 +205,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga421e9e4d09d518d0491a53c
 <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 scd30 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 scd30 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>
@@ -245,8 +245,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga6eb636373fe6dcdf6f02860
 <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 scd30 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 scd30 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>
@@ -285,8 +285,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf9e9ba3703dc65a0501d36a
 <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 scd30 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 scd30 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>
@@ -325,8 +325,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga45c3e907c8f320119c2911e
 <p>link iic_read_cmd 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 scd30 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an iic_read_cmd function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an scd30 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an iic_read_cmd function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -365,8 +365,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga887d39db13386cc7ad222e0
 <p>link iic_write_cmd 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 scd30 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an iic_write_cmd function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an scd30 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an iic_write_cmd function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -405,8 +405,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab82b591eef4cf78b1e27f00
 <p>initialize scd30_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 scd30 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>is scd30_handle_t </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an scd30 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>scd30_handle_t </td></tr>
   </table>
   </dd>
 </dl>
@@ -445,8 +445,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2c475bf8bed50b01c693d3f
 <p>link uart_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 scd30 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a uart_deinit function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an scd30 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a uart_deinit function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -485,8 +485,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gafc3a6799833821171d25e07
 <p>link uart_flush 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 scd30 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a uart_flush function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an scd30 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a uart_flush function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -525,8 +525,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga9e675ebff56068b16ce9f11
 <p>link uart_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 scd30 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a uart_init function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an scd30 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a uart_init function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -565,8 +565,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf389f704fa7f5df9f9cb9b3
 <p>link uart_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 scd30 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a uart_read function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an scd30 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a uart_read function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -605,8 +605,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga7f08bb9accabf6e5d45e93a
 <p>link uart_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 scd30 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a uart_write function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an scd30 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a uart_write function address </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__scd30__test__driver.html

@@ -135,8 +135,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga9b61da45bbfc2ef4525c42d
 <p>read test </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">times</td><td>is the test times </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">times</td><td>test times </td></tr>
   </table>
   </dd>
 </dl>
@@ -170,7 +170,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae82b5bbfa7496b2761f52eb
 <p>register test </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">interface</td><td>chip interface </td></tr>
   </table>
   </dd>
 </dl>