Merge pull request #19 from libdriver/dev

fix: fix doc bugs

Author: libdriver

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.0.3 (2024-11-30)
+
+## Bug Fixes
+
+- fix doc bugs
+
 ## 1.0.2 (2024-09-27)
 
 ## Bug Fixes

doc/html/group__amg8833__basic__driver.html

@@ -264,7 +264,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaeac9c31eae47cd06f9b27a5
 <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>
@@ -298,7 +298,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga8b8a843d8e12f11db24ce81
 <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">*temp</td><td>points to a temperature buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*temp</td><td>pointer to a temperature buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -332,7 +332,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga912686c4a49a929e45c8f03
 <p>basic example read temperature array </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">**temp</td><td>points to a temperature array </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">**temp</td><td>pointer to a temperature array </td></tr>
   </table>
   </dd>
 </dl>
@@ -394,7 +394,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga169c81e488f468aea730f3c
 <p>interrupt example get interrupt table </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">**table</td><td>points to a table buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">**table</td><td>pointer to a table buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -462,12 +462,12 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga528d104397e4b578e327af9
 <p>interrupt 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">mode</td><td>is the interrupt mode </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">high_level</td><td>is the high level </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">low_level</td><td>is the low level </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">hysteresis_level</td><td>is the hysteresis level </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*callback</td><td>points to a 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">mode</td><td>interrupt mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">high_level</td><td>high level </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">low_level</td><td>low level </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">hysteresis_level</td><td>hysteresis level </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*callback</td><td>pointer to a callback function </td></tr>
   </table>
   </dd>
 </dl>
@@ -529,7 +529,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2b90394ed88394f994828c1
 <p>interrupt example read temperature </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*temp</td><td>points to a temperature buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*temp</td><td>pointer to a temperature buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -563,7 +563,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab3ca4ce06bf922466e5be85
 <p>interrupt example read temperature array </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">**temp</td><td>points to a temperature array </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">**temp</td><td>pointer to a temperature array </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__amg8833__example__driver.html

@@ -147,10 +147,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa53b484532909e605f35e7a
 <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 amg8833 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 amg8833 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="#ga143736a96a6c4a1bc1afce9
 <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 amg8833 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 amg8833 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__amg8833__extern__driver.html

@@ -150,7 +150,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga6d52b1b4bd97159bd59c957
 <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>
@@ -179,7 +179,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga278f560981f6de1d95751f1
 <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>
@@ -286,10 +286,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa4b15bbdbd25ed1e302e724
 <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 iic device write address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is 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>
@@ -345,10 +345,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga293a5332b7ca874baca8b40
 <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 iic device write address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is 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>
@@ -382,7 +382,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga0529b581160670e86a6cfa2
 <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 interrupt type </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>interrupt type </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__amg8833__interface__driver.html

@@ -153,8 +153,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gafffd66b043557e26788dd4a
 <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 amg8833 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 amg8833 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>
@@ -193,8 +193,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf8db7a0db80a6c00b013c91
 <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 amg8833 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 amg8833 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>
@@ -233,8 +233,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf3c5e58725c979bbac475df
 <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 amg8833 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 amg8833 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>
@@ -273,8 +273,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga7237893ce8b438333209900
 <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 amg8833 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 amg8833 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>
@@ -313,8 +313,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga555b99baf9537bfe9c105eb
 <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 amg8833 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 amg8833 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>
@@ -353,8 +353,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga68f0650e68b53e12af94837
 <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 amg8833 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 amg8833 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>
@@ -393,8 +393,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga7babcaea85c5a96998fd38d
 <p>initialize amg8833_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 amg8833 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>is amg8833_handle_t </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an amg8833 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>amg8833_handle_t </td></tr>
   </table>
   </dd>
 </dl>
@@ -433,8 +433,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf0e120c51d957b004fc31ca
 <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 amg8833 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 amg8833 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>

doc/html/group__amg8833__link__driver.html

@@ -165,12 +165,12 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga669bdbd7f13094ef51cc7d8
 <p>interrupt test </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">mode</td><td>is the interrupt mode </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">high_level</td><td>is the high level </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">low_level</td><td>is the low level </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">hysteresis_level</td><td>is the hysteresis level </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">times</td><td>is the read times </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">mode</td><td>interrupt mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">high_level</td><td>high level </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">low_level</td><td>low level </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">hysteresis_level</td><td>hysteresis level </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">times</td><td>test times </td></tr>
   </table>
   </dd>
 </dl>
@@ -242,8 +242,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3e2dabe772eeaf2649b4073
 <p>read test </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">times</td><td>is the read times </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">times</td><td>test times </td></tr>
   </table>
   </dd>
 </dl>
@@ -277,7 +277,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gadbd25d8f7cb2f1f764e5613
 <p>register test </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>

doc/html/group__amg8833__test__driver.html

@@ -40,7 +40,7 @@ static amg8833_handle_t gs_handle;        /**< amg8833 handle */
 
 /**
  * @brief     basic example init
- * @param[in] addr_pin is the iic device address
+ * @param[in] addr_pin iic device address
  * @return    status code
  *            - 0 success
  *            - 1 init failed
@@ -142,7 +142,7 @@ uint8_t amg8833_basic_deinit(void)
 
 /**
  * @brief      basic example read temperature array
- * @param[out] **temp points to a temperature array
+ * @param[out] **temp pointer to a temperature array
  * @return     status code
  *             - 0 success
  *             - 1 read temperature array failed
@@ -165,7 +165,7 @@ uint8_t amg8833_basic_read_temperature_array(float temp[8][8])
 
 /**
  * @brief      basic example read temperature
- * @param[out] *temp points to a temperature buffer
+ * @param[out] *temp pointer to a temperature buffer
  * @return     status code
  *             - 0 success
  *             - 1 read temperature failed