Merge pull request #15 from libdriver/dev

fix: fix doc errors

Author: libdriver

CHANGELOG.md

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

doc/html/group__max30105__basic__driver.html

@@ -547,7 +547,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaae03d8f8bb92acaf419f078
 <p>fifo example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*fifo_receive_callback</td><td>points to a fifo receive callback </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*fifo_receive_callback</td><td>pointer to a fifo receive callback </td></tr>
   </table>
   </dd>
 </dl>
@@ -631,10 +631,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf9071a31fa9edf6b9c448a2
 <p>read the data </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*raw_red</td><td>points to a red raw data buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*raw_ir</td><td>points to a ir raw data buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*raw_green</td><td>points to a green raw 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">*raw_red</td><td>pointer to a red raw data buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*raw_ir</td><td>pointer to a ir raw data buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*raw_green</td><td>pointer to a green raw 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__max30105__example__driver.html

@@ -147,10 +147,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae30fe43339f910dbe54ac6f
 <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 max30105 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 max30105 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="#gaf28dca7757fc96d734ee407
 <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 max30105 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 max30105 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__max30105__extern__driver.html

@@ -150,7 +150,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga05fd6dd464e408afb68dbc3
 <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="#ga0071b39dcb5d7015dbc2ae9
 <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="#ga5c99c8f5299379f77fce375
 <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>
@@ -345,10 +345,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2e85e704f4b77a3c9a15b00
 <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>
@@ -382,7 +382,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga84d10815cca90bf4d9be952
 <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>

doc/html/group__max30105__interface__driver.html

@@ -153,8 +153,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga1b66a2c9634fb719c02d9fa
 <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 a max30105 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 a max30105 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="#ga3f21a6c325c7458d41577b2
 <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 a max30105 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 a max30105 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="#gaf8c3b81d625583fb3a6d75c
 <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 a max30105 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 a max30105 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="#gaf1ef8748f2e50ad916acd2a
 <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 a max30105 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 a max30105 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="#ga8ee79d7deff82f73e25ceca
 <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 a max30105 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 a max30105 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="#ga4c1e1bf24f8eb3d618adc2e
 <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 a max30105 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 a max30105 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="#gaf5495689b1697f684e31fdd
 <p>initialize max30105_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 a max30105 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>is max30105_handle_t </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a max30105 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>max30105_handle_t </td></tr>
   </table>
   </dd>
 </dl>
@@ -433,8 +433,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga86817079643b4e70a85ffac
 <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 a max30105 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 a max30105 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__max30105__link__driver.html

@@ -128,7 +128,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf2b9e0c2d282b17277d3e23
 <p>fifo test </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <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">times</td><td>test times </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__max30105__test__driver.html

@@ -60,7 +60,7 @@ uint8_t max30105_fifo_irq_handler(void)
 
 /**
  * @brief     fifo example init
- * @param[in] *fifo_receive_callback points to a fifo receive callback
+ * @param[in] *fifo_receive_callback pointer to a fifo receive callback
  * @return    status code
  *            - 0 success
  *            - 1 init failed
@@ -378,10 +378,10 @@ uint8_t max30105_fifo_deinit(void)
 
 /**
  * @brief         read the data
- * @param[out]    *raw_red points to a red raw data buffer
- * @param[out]    *raw_ir points to a ir raw data buffer
- * @param[out]    *raw_green points to a green raw data buffer
- * @param[in,out] *len points to a length buffer
+ * @param[out]    *raw_red pointer to a red raw data buffer
+ * @param[out]    *raw_ir pointer to a ir raw data buffer
+ * @param[out]    *raw_green pointer to a green raw data buffer
+ * @param[in,out] *len pointer to a length buffer
  * @return        status code
  *                - 0 success
  *                - 1 read failed

example/driver_max30105_fifo.c

@@ -85,7 +85,7 @@ uint8_t max30105_fifo_irq_handler(void);
 
 /**
  * @brief     fifo example init
- * @param[in] *fifo_receive_callback points to a fifo receive callback
+ * @param[in] *fifo_receive_callback pointer to a fifo receive callback
  * @return    status code
  *            - 0 success
  *            - 1 init failed
@@ -104,10 +104,10 @@ uint8_t max30105_fifo_deinit(void);
 
 /**
  * @brief         read the data
- * @param[out]    *raw_red points to a red raw data buffer
- * @param[out]    *raw_ir points to a ir raw data buffer
- * @param[out]    *raw_green points to a green raw data buffer
- * @param[in,out] *len points to a length buffer
+ * @param[out]    *raw_red pointer to a red raw data buffer
+ * @param[out]    *raw_ir pointer to a ir raw data buffer
+ * @param[out]    *raw_green pointer to a green raw data buffer
+ * @param[in,out] *len pointer to a length buffer
  * @return        status code
  *                - 0 success
  *                - 1 read failed

example/driver_max30105_fifo.h

@@ -70,10 +70,10 @@ uint8_t max30105_interface_iic_deinit(void);
 
 /**
  * @brief      interface iic bus read
- * @param[in]  addr is the iic device write address
- * @param[in]  reg is the iic register address
- * @param[out] *buf points to a data buffer
- * @param[in]  len is the length of the data buffer
+ * @param[in]  addr iic device write address
+ * @param[in]  reg iic register address
+ * @param[out] *buf pointer to a data buffer
+ * @param[in]  len length of the data buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed
@@ -83,10 +83,10 @@ uint8_t max30105_interface_iic_read(uint8_t addr, uint8_t reg, uint8_t *buf, uin
 
 /**
  * @brief     interface iic bus write
- * @param[in] addr is the iic device write address
- * @param[in] reg is the iic register address
- * @param[in] *buf points to a data buffer
- * @param[in] len is the length of the data buffer
+ * @param[in] addr iic device write address
+ * @param[in] reg iic register address
+ * @param[in] *buf pointer to a data buffer
+ * @param[in] len length of the data buffer
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -96,21 +96,21 @@ uint8_t max30105_interface_iic_write(uint8_t addr, uint8_t reg, uint8_t *buf, ui
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void max30105_interface_delay_ms(uint32_t ms);
 
 /**
  * @brief     interface print format data
- * @param[in] fmt is the format data
+ * @param[in] fmt format data
  * @note      none
  */
 void max30105_interface_debug_print(const char *const fmt, ...);
 
 /**
  * @brief     interface receive callback
- * @param[in] type is the irq type
+ * @param[in] type irq type
  * @note      none
  */
 void max30105_interface_receive_callback(uint8_t type);

interface/driver_max30105_interface.h

@@ -62,10 +62,10 @@ uint8_t max30105_interface_iic_deinit(void)
 
 /**
  * @brief      interface iic bus read
- * @param[in]  addr is the iic device write address
- * @param[in]  reg is the iic register address
- * @param[out] *buf points to a data buffer
- * @param[in]  len is the length of the data buffer
+ * @param[in]  addr iic device write address
+ * @param[in]  reg iic register address
+ * @param[out] *buf pointer to a data buffer
+ * @param[in]  len length of the data buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed
@@ -78,10 +78,10 @@ uint8_t max30105_interface_iic_read(uint8_t addr, uint8_t reg, uint8_t *buf, uin
 
 /**
  * @brief     interface iic bus write
- * @param[in] addr is the iic device write address
- * @param[in] reg is the iic register address
- * @param[in] *buf points to a data buffer
- * @param[in] len is the length of the data buffer
+ * @param[in] addr iic device write address
+ * @param[in] reg iic register address
+ * @param[in] *buf pointer to a data buffer
+ * @param[in] len length of the data buffer
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -94,7 +94,7 @@ uint8_t max30105_interface_iic_write(uint8_t addr, uint8_t reg, uint8_t *buf, ui
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void max30105_interface_delay_ms(uint32_t ms)
@@ -104,7 +104,7 @@ void max30105_interface_delay_ms(uint32_t ms)
 
 /**
  * @brief     interface print format data
- * @param[in] fmt is the format data
+ * @param[in] fmt format data
  * @note      none
  */
 void max30105_interface_debug_print(const char *const fmt, ...)
@@ -114,7 +114,7 @@ void max30105_interface_debug_print(const char *const fmt, ...)
 
 /**
  * @brief     interface receive callback
- * @param[in] type is the irq type
+ * @param[in] type irq type
  * @note      none
  */
 void max30105_interface_receive_callback(uint8_t type)